Namespace: Resolvers
Functions
resolveBoolean
▸ resolveBoolean(parameter
, customs?
): Result
<boolean
, ArgumentBooleanError
>
Parameters
Name | Type |
---|---|
parameter | string |
customs? | Object |
customs.falses? | readonly string [] |
customs.truths? | readonly string [] |
Returns
Result
<boolean
, ArgumentBooleanError
>
Defined in
projects/framework/src/lib/resolvers/boolean.ts:7
resolveChannel
▸ resolveChannel(parameter
, messageOrInteraction
): Result
<ChannelTypes
, ArgumentChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
messageOrInteraction | Message <boolean > | CommandInteraction <CacheType > |
Returns
Result
<ChannelTypes
, ArgumentChannelError
>
Defined in
projects/framework/src/lib/resolvers/channel.ts:7
resolveDMChannel
▸ resolveDMChannel(parameter
, messageOrInteraction
): Result
<DMChannel
, ArgumentChannelError
| ArgumentDMChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
messageOrInteraction | Message <boolean > | CommandInteraction <CacheType > |
Returns
Result
<DMChannel
, ArgumentChannelError
| ArgumentDMChannelError
>
Defined in
projects/framework/src/lib/resolvers/dmChannel.ts:7
resolveDate
▸ resolveDate(parameter
, options?
): Result
<Date
, ArgumentDateError
| ArgumentDateTooEarly
| ArgumentDateTooFar
>
Parameters
Name | Type |
---|---|
parameter | string |
options? | Object |
options.maximum? | number |
options.minimum? | number |
Returns
Result
<Date
, ArgumentDateError
| ArgumentDateTooEarly
| ArgumentDateTooFar
>
Defined in
projects/framework/src/lib/resolvers/date.ts:4
resolveEmoji
▸ resolveEmoji(parameter
): Result
<EmojiObject
, Identifiers
>
Parameters
Name | Type |
---|---|
parameter | string |
Returns
Result
<EmojiObject
, Identifiers
>
Defined in
projects/framework/src/lib/resolvers/emoji.ts:6
resolveEnum
▸ resolveEnum(parameter
, options?
): Result
<string
, ArgumentEnumEmptyError
| ArgumentEnumError
>
Parameters
Name | Type |
---|---|
parameter | string |
options? | Object |
options.caseInsensitive? | boolean |
options.enum? | string [] |
Returns
Result
<string
, ArgumentEnumEmptyError
| ArgumentEnumError
>
Defined in
projects/framework/src/lib/resolvers/enum.ts:4
resolveFloat
▸ resolveFloat(parameter
, options?
): Result
<number
, ArgumentFloatError
| ArgumentFloatTooSmall
| ArgumentFloatTooLarge
>
Parameters
Name | Type |
---|---|
parameter | string |
options? | Object |
options.maximum? | number |
options.minimum? | number |
Returns
Result
<number
, ArgumentFloatError
| ArgumentFloatTooSmall
| ArgumentFloatTooLarge
>
Defined in
projects/framework/src/lib/resolvers/float.ts:4
resolveGuild
▸ resolveGuild(parameter
): Promise
<Result
<Guild
, ArgumentGuildError
>>
Parameters
Name | Type |
---|---|
parameter | string |
Returns
Promise
<Result
<Guild
, ArgumentGuildError
>>
Defined in
projects/framework/src/lib/resolvers/guild.ts:7
resolveGuildCategoryChannel
▸ resolveGuildCategoryChannel(parameter
, guild
): Result
<CategoryChannel
, ArgumentGuildChannelError
| ArgumentGuildCategoryChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<CategoryChannel
, ArgumentGuildChannelError
| ArgumentGuildCategoryChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildCategoryChannel.ts:7
resolveGuildChannel
▸ resolveGuildChannel(parameter
, guild
): Result
<GuildBasedChannelTypes
, ArgumentGuildChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<GuildBasedChannelTypes
, ArgumentGuildChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildChannel.ts:7
resolveGuildNewsChannel
▸ resolveGuildNewsChannel(parameter
, guild
): Result
<NewsChannel
, ArgumentGuildChannelError
| ArgumentGuildNewsChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<NewsChannel
, ArgumentGuildChannelError
| ArgumentGuildNewsChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildNewsChannel.ts:7
resolveGuildNewsThreadChannel
▸ resolveGuildNewsThreadChannel(parameter
, guild
): Result
<ThreadChannel
, ArgumentGuildChannelError
| ArgumentGuildThreadChannelError
| ArgumentGuildNewsThreadChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<ThreadChannel
, ArgumentGuildChannelError
| ArgumentGuildThreadChannelError
| ArgumentGuildNewsThreadChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildNewsThreadChannel.ts:7
resolveGuildPrivateThreadChannel
▸ resolveGuildPrivateThreadChannel(parameter
, guild
): Result
<ThreadChannel
, ArgumentGuildChannelError
| ArgumentGuildThreadChannelError
| ArgumentGuildPrivateThreadChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<ThreadChannel
, ArgumentGuildChannelError
| ArgumentGuildThreadChannelError
| ArgumentGuildPrivateThreadChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildPrivateThreadChannel.ts:7
resolveGuildPublicThreadChannel
▸ resolveGuildPublicThreadChannel(parameter
, guild
): Result
<ThreadChannel
, ArgumentGuildChannelError
| ArgumentGuildThreadChannelError
| ArgumentGuildPublicThreadChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<ThreadChannel
, ArgumentGuildChannelError
| ArgumentGuildThreadChannelError
| ArgumentGuildPublicThreadChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildPublicThreadChannel.ts:7
resolveGuildStageVoiceChannel
▸ resolveGuildStageVoiceChannel(parameter
, guild
): Result
<StageChannel
, ArgumentGuildChannelError
| ArgumentGuildStageVoiceChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<StageChannel
, ArgumentGuildChannelError
| ArgumentGuildStageVoiceChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildStageVoiceChannel.ts:7
resolveGuildTextChannel
▸ resolveGuildTextChannel(parameter
, guild
): Result
<TextChannel
, ArgumentGuildChannelError
| ArgumentGuildTextChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<TextChannel
, ArgumentGuildChannelError
| ArgumentGuildTextChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildTextChannel.ts:7
resolveGuildThreadChannel
▸ resolveGuildThreadChannel(parameter
, guild
): Result
<ThreadChannel
, ArgumentGuildChannelError
| ArgumentGuildThreadChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<ThreadChannel
, ArgumentGuildChannelError
| ArgumentGuildThreadChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildThreadChannel.ts:7
resolveGuildVoiceChannel
▸ resolveGuildVoiceChannel(parameter
, guild
): Result
<VoiceChannel
, ArgumentGuildChannelError
| ArgumentGuildVoiceChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Result
<VoiceChannel
, ArgumentGuildChannelError
| ArgumentGuildVoiceChannelError
>
Defined in
projects/framework/src/lib/resolvers/guildVoiceChannel.ts:7
resolveHyperlink
▸ resolveHyperlink(parameter
): Result
<URL
, ArgumentHyperlinkError
>
Parameters
Name | Type |
---|---|
parameter | string |
Returns
Result
<URL
, ArgumentHyperlinkError
>
Defined in
projects/framework/src/lib/resolvers/hyperlink.ts:5
resolveInteger
▸ resolveInteger(parameter
, options?
): Result
<number
, ArgumentIntegerError
| ArgumentIntegerTooSmall
| ArgumentIntegerTooLarge
>
Parameters
Name | Type |
---|---|
parameter | string |
options? | Object |
options.maximum? | number |
options.minimum? | number |
Returns
Result
<number
, ArgumentIntegerError
| ArgumentIntegerTooSmall
| ArgumentIntegerTooLarge
>
Defined in
projects/framework/src/lib/resolvers/integer.ts:4
resolveMember
▸ resolveMember(parameter
, guild
, performFuzzySearch?
): Promise
<Result
<GuildMember
, ArgumentMemberError
>>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
performFuzzySearch? | boolean |
Returns
Promise
<Result
<GuildMember
, ArgumentMemberError
>>
Defined in
projects/framework/src/lib/resolvers/member.ts:7
resolveMessage
▸ resolveMessage(parameter
, options
): Promise
<Result
<Message
, ArgumentMessageError
>>
Parameters
Name | Type |
---|---|
parameter | string |
options | MessageResolverOptions |
Returns
Promise
<Result
<Message
, ArgumentMessageError
>>
Defined in
projects/framework/src/lib/resolvers/message.ts:40
resolveNumber
▸ resolveNumber(parameter
, options?
): Result
<number
, ArgumentNumberError
| ArgumentNumberTooSmall
| ArgumentNumberTooLarge
>
Parameters
Name | Type |
---|---|
parameter | string |
options? | Object |
options.maximum? | number |
options.minimum? | number |
Returns
Result
<number
, ArgumentNumberError
| ArgumentNumberTooSmall
| ArgumentNumberTooLarge
>
Defined in
projects/framework/src/lib/resolvers/number.ts:4
resolvePartialDMChannel
▸ resolvePartialDMChannel(parameter
, message
): Result
<DMChannel
| PartialDMChannel
, ArgumentChannelError
| ArgumentDMChannelError
>
Parameters
Name | Type |
---|---|
parameter | string |
message | Message <boolean > |
Returns
Result
<DMChannel
| PartialDMChannel
, ArgumentChannelError
| ArgumentDMChannelError
>
Defined in
projects/framework/src/lib/resolvers/partialDMChannel.ts:7
resolveRole
▸ resolveRole(parameter
, guild
): Promise
<Result
<Role
, ArgumentRoleError
>>
Parameters
Name | Type |
---|---|
parameter | string |
guild | Guild |
Returns
Promise
<Result
<Role
, ArgumentRoleError
>>
Defined in
projects/framework/src/lib/resolvers/role.ts:6
resolveString
▸ resolveString(parameter
, options?
): Result
<string
, ArgumentStringTooShort
| ArgumentStringTooLong
>
Parameters
Name | Type |
---|---|
parameter | string |
options? | Object |
options.maximum? | number |
options.minimum? | number |
Returns
Result
<string
, ArgumentStringTooShort
| ArgumentStringTooLong
>
Defined in
projects/framework/src/lib/resolvers/string.ts:4
resolveUser
▸ resolveUser(parameter
): Promise
<Result
<User
, ArgumentUserError
>>
Parameters
Name | Type |
---|---|
parameter | string |
Returns
Promise
<Result
<User
, ArgumentUserError
>>