🗣️Guild Channels

Prototypes from GuildChannelManager

Getting a channel by ID

// discord.js
<Guild>.channels.cache.get(string);

// djs-protofy
<Guild>.channels.getById(string); // Channel | undefined
// OR
<Guild>.channels.getById(string, ChannelType); // Channel | undefined

Getting a channel by Name

// discord.js
<Guild>.channels.cache.find(channel => channel.name === string);

// djs-protofy
<Guild>.channels.getByName(string | RegExp); // Channel | undefined
// OR
<Guild>.channels.getByName(string | RegExp, ChannelType); // Channel | undefined

Getting a channel by Topic

// discord.js
<Guild>.channels.cache.find(channel => channel.topic === string);

// djs-protofy
<Guild>.channels.getByTopic(string | RegExp); // Channel | undefined
// OR
<Guild>.channels.getByTopic(string | RegExp, ChannelType); // Channel | undefined

Getting a channel by Url

// discord.js
<Guild>.channels.cache.find(channel => channel.url === "https://discord.com/...url");

// djs-protofy
<Guild>.channels.getByUrl("https://discord.com/...url"); // Channel | undefined
// OR
<Guild>.channels.getByUrl("https://discord.com/...url", ChannelType); // Channel | undefined

Getting a category by ID

// discord.js
<Guild>.channels.cache.get(string);

// djs-protofy
<Guild>.channels.getCategoryById(string); // CategoryChannel | undefined

Getting a category by Name

// discord.js
<Guild>.channels.cache.find(channel => channel.name === string);

// djs-protofy
<Guild>.channels.getCategoryByName(string | RegExp); // CategoryChannel | undefined

Getting a channel voice by an User ID

// discord.js
<Guild>.channels.cache.find((channel) => {
  if (!channel.isVoiceBased()) return false;
  return channel.members.has(string);
})

// djs-protofy
<Guild>.channels.getVoiceByUserId(string); // VoiceBasedChannel | undefined

Filtering channels by Types

// discord.js
<Guild>.channels.cache.filter(channel => channel.type === ChannelType)

// djs-protofy
<Guild>.channels.filterByTypes(ChannelType | ChannelType[]); // Collection<string, Channel>

Searching for a channel

// discord.js
<Guild>.channels.cache.find(channel => {
    return channel.id === string
       || channel.name === string
       || channel.topic === string;
});

// djs-protofy
<Guild>.channels.searchBy(string); // Channel | undefined
// OR
<Guild>.channels.searchBy(string[]); // Collection<string, Channel>

If you use an array of String, you will receive a Collection instead of Channel

Last updated