discord-bot-shared 0.4.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -132,13 +132,13 @@ interface Command {
132
132
 
133
133
  ---
134
134
 
135
- #### `function getChannelByName`
135
+ #### `function getChannel`
136
136
 
137
- Returns a guild channel of the given name and type, otherwise returns `undefined`.
137
+ Returns the guild channel of the given name/ID and type, otherwise returns `undefined`.
138
138
 
139
139
  ```
140
- async function getChannelByName<T extends NonThreadGuildBasedChannel>(
141
- channelName: string,
140
+ async function getChannel<T extends NonThreadGuildBasedChannel>(
141
+ channelNameOrId: string,
142
142
  channelType: NonThreadGuildBasedChannelType,
143
143
  ): Promise<T | undefined>
144
144
  ```
@@ -149,7 +149,7 @@ async function getChannelByName<T extends NonThreadGuildBasedChannel>(
149
149
  - For example:
150
150
 
151
151
  ```
152
- const someTextChannel = await getChannelByName<TextChannel>('some-text-channel', ChannelType.GuildText)
152
+ const someTextChannel = await getChannel<TextChannel>('some-text-channel', ChannelType.GuildText)
153
153
  ```
154
154
 
155
155
  ---
package/dist/index.d.ts CHANGED
@@ -5,4 +5,4 @@ export default login
5
5
  export { Command } from './commands.js'
6
6
  export { default as getGuildCache } from './guildCache.js'
7
7
  export { InteractionCheck } from './interactionCreate.js'
8
- export { getChannelByName, isCategoryChannel, isTextChannel, throwError } from './util.js'
8
+ export { getChannel, isCategoryChannel, isTextChannel, throwError } from './util.js'
package/dist/index.js CHANGED
@@ -19,5 +19,5 @@ async function login(botIntents, projectMetaURL, interactionCheck) {
19
19
  }
20
20
  export default login
21
21
  export { default as getGuildCache } from './guildCache.js'
22
- export { getChannelByName, isCategoryChannel, isTextChannel, throwError } from './util.js'
22
+ export { getChannel, isCategoryChannel, isTextChannel, throwError } from './util.js'
23
23
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,YAAY,CAAA;AAClD,OAAO,gBAAgB,MAAM,eAAe,CAAA;AAC5C,OAAO,cAAc,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,yBAA+C,MAAM,wBAAwB,CAAA;AACpF,OAAO,aAAa,MAAM,YAAY,CAAA;AAEtC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAA;AAC5C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAA;AAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAA;AAE1C,KAAK,UAAU,KAAK,CAAC,UAAyB,EAAE,cAAsB,EAAE,gBAAmC;IACzG,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;IAClC,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;IAEpF,aAAa,CAAC,GAAG,CAAC,CAAA;IAClB,yBAAyB,CAAC,GAAG,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IAC1D,KAAK,cAAc,CAAC,cAAc,CAAC,CAAA;IAEnC,MAAM,CAAC,GAAG,CAAC,CAAA;IAEX,KAAK,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;IACxB,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,eAAe,KAAK,CAAA;AAEpB,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE1D,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,YAAY,CAAA;AAClD,OAAO,gBAAgB,MAAM,eAAe,CAAA;AAC5C,OAAO,cAAc,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,yBAA+C,MAAM,wBAAwB,CAAA;AACpF,OAAO,aAAa,MAAM,YAAY,CAAA;AAEtC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAA;AAC5C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAA;AAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAA;AAE1C,KAAK,UAAU,KAAK,CAAC,UAAyB,EAAE,cAAsB,EAAE,gBAAmC;IACzG,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;IAClC,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;IAEpF,aAAa,CAAC,GAAG,CAAC,CAAA;IAClB,yBAAyB,CAAC,GAAG,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IAC1D,KAAK,cAAc,CAAC,cAAc,CAAC,CAAA;IAEnC,MAAM,CAAC,GAAG,CAAC,CAAA;IAEX,KAAK,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;IACxB,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,eAAe,KAAK,CAAA;AAEpB,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE1D,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA"}
package/dist/util.d.ts CHANGED
@@ -5,11 +5,11 @@ declare type NonThreadGuildBasedChannelType =
5
5
  | ChannelType.GuildNews
6
6
  | ChannelType.GuildStageVoice
7
7
  | ChannelType.GuildCategory
8
- declare function getChannelByName<T extends NonThreadGuildBasedChannel>(
9
- channelName: string,
8
+ declare function getChannel<T extends NonThreadGuildBasedChannel>(
9
+ channelNameOrId: string,
10
10
  channelType: NonThreadGuildBasedChannelType,
11
11
  ): Promise<T | undefined>
12
12
  declare function isTextChannel(channel: BaseChannel | APIPartialChannel): channel is TextChannel
13
13
  declare function isCategoryChannel(channel: BaseChannel): channel is CategoryChannel
14
14
  declare function throwError(error: string): never
15
- export { getChannelByName, isTextChannel, isCategoryChannel, throwError }
15
+ export { getChannel, isTextChannel, isCategoryChannel, throwError }
package/dist/util.js CHANGED
@@ -1,9 +1,12 @@
1
1
  import { ChannelType } from 'discord.js'
2
2
  import getGuildCache from './guildCache.js'
3
- async function getChannelByName(channelName, channelType) {
3
+ async function getChannel(channelNameOrId, channelType) {
4
4
  const { channels } = (await getGuildCache()) || throwError('Unable to get guild cache.')
5
- const channel = channels.find((channel) => channel.name === channelName)
6
- return channel && channel.type === channelType ? channel : undefined
5
+ let channel
6
+ channel = channels.find((channel) => channel.name === channelNameOrId)
7
+ if (channel) return channel.type === channelType ? channel : undefined
8
+ channel = channels.get(channelNameOrId)
9
+ if (channel) return channel.type === channelType ? channel : undefined
7
10
  }
8
11
  function isTextChannel(channel) {
9
12
  return channel.type === ChannelType.GuildText
@@ -14,5 +17,5 @@ function isCategoryChannel(channel) {
14
17
  function throwError(error) {
15
18
  throw new Error(error)
16
19
  }
17
- export { getChannelByName, isTextChannel, isCategoryChannel, throwError }
20
+ export { getChannel, isTextChannel, isCategoryChannel, throwError }
18
21
  //# sourceMappingURL=util.js.map
package/dist/util.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmD,WAAW,EAA2C,MAAM,YAAY,CAAA;AAClI,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAS3C,KAAK,UAAU,gBAAgB,CAC7B,WAAmB,EACnB,WAA2C;IAE3C,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,aAAa,EAAE,CAAC,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAA;IACxF,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAA;IAExE,OAAO,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAE,OAAa,CAAC,CAAC,CAAC,SAAS,CAAA;AAC7E,CAAC;AAED,SAAS,aAAa,CAAC,OAAwC;IAC7D,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,CAAA;AAC/C,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAoB;IAC7C,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,aAAa,CAAA;AACnD,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;AACxB,CAAC;AAED,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,iBAAiB,EAAE,UAAU,EAAE,CAAA"}
1
+ {"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmD,WAAW,EAA2C,MAAM,YAAY,CAAA;AAClI,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAS3C,KAAK,UAAU,UAAU,CACvB,eAAuB,EACvB,WAA2C;IAE3C,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,aAAa,EAAE,CAAC,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAA;IAExF,IAAI,OAA+C,CAAA;IACnD,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,eAAe,CAAC,CAAA;IACtE,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAE,OAAa,CAAC,CAAC,CAAC,SAAS,CAAA;IAE7E,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;IACvC,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAE,OAAa,CAAC,CAAC,CAAC,SAAS,CAAA;AAC/E,CAAC;AAED,SAAS,aAAa,CAAC,OAAwC;IAC7D,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,CAAA;AAC/C,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAoB;IAC7C,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,aAAa,CAAA;AACnD,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;AACxB,CAAC;AAED,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAE,UAAU,EAAE,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "discord-bot-shared",
3
- "version": "0.4.1",
3
+ "version": "0.5.0",
4
4
  "type": "module",
5
5
  "description": "Modules for creating discord bots.",
6
6
  "repository": "github:adamhl8/discord-bot-shared",