Class CompiledFunction<T, Unwrap>

Type Parameters

T extends [...IArg[]] = IArg[]
Unwrap extends boolean = boolean

Index

Constructors

constructor

new CompiledFunction<T, Unwrap>(raw): CompiledFunction<T, Unwrap>
Type Parameters
- T extends IArg<ArgType, boolean, boolean, EnumLike<any>>[] = IArg<ArgType, boolean, boolean, EnumLike<any>>[]
- Unwrap extends boolean = boolean
Parameters
- raw: ICompiledFunction
Returns CompiledFunction<T, Unwrap>
- Defined in src/structures/@internal/CompiledFunction.ts:59

Properties

`Readonly` data

data: IExtendedCompiledFunction

`Readonly` fn

fn: NativeFunction<T, Unwrap>

`Static` `Readonly` CDNIdRegex

CDNIdRegex: RegExp = ...

`Static` `Readonly` IdRegex

IdRegex: RegExp = ...

`Static` `Readonly` OverwriteSymbolMapping

OverwriteSymbolMapping: {
    +: boolean;
    -: boolean;
    /: null;
} = ...

Type declaration

+: boolean
-: boolean
/: null

`Static` `Readonly` URLRegex

URLRegex: RegExp = ...

Accessors

display

get display(): string
Returns string
- Defined in src/structures/@internal/CompiledFunction.ts:100

hasFields

get hasFields(): boolean
Returns boolean
- Defined in src/structures/@internal/CompiledFunction.ts:501

`Private` resolveUnknown

get resolveUnknown(): ((ctx, arg, str, ref) => string)
Returns ((ctx, arg, str, ref) => string)
- - (ctx, arg, str, ref): string
  - Parameters
    - ctx: Context
    - arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
    - str: string
    - ref: unknown[]
    Returns string
- Defined in src/structures/@internal/CompiledFunction.ts:260

Methods

`Private` argTypeRejection

argTypeRejection(arg, value): Return<Error>
Parameters
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- value: unknown
Returns Return<Error>
- Defined in src/structures/@internal/CompiledFunction.ts:233

break

break(): Return<Break>
Returns Return<Break>
- Defined in src/structures/@internal/CompiledFunction.ts:572

continue

continue(): Return<Continue>
Returns Return<Continue>
- Defined in src/structures/@internal/CompiledFunction.ts:576

customError

customError(msg): Return<Error>
Parameters
- msg: string
Returns Return<Error>
- Defined in src/structures/@internal/CompiledFunction.ts:516

displayField

displayField(i): null | string
Parameters
- i: number
Returns null | string
- Defined in src/structures/@internal/CompiledFunction.ts:87

error

error(err): Return<Error>
Parameters
- err: Error
Returns Return<Error>
- Defined in src/structures/@internal/CompiledFunction.ts:509
error<T>(type, ...args): Return<Error>
Type Parameters
- T extends ErrorType
Parameters
- type: T
- Rest ...args: GetErrorArgs<T>
Returns Return<Error>
- Defined in src/structures/@internal/CompiledFunction.ts:510

execute

execute(ctx): Promise<Return<ReturnType>>
Parameters
- ctx: Context
Returns Promise<Return<ReturnType>>
- Defined in src/structures/@internal/CompiledFunction.ts:520

`Private` fail

fail(ctx, code?): Promise<Return<ReturnType>>
Parameters
- ctx: Context
- Optional code: IExtendedCompiledFunctionField
Returns Promise<Return<ReturnType>>
- Defined in src/structures/@internal/CompiledFunction.ts:537

getFunction

getFunction(fieldIndex, ref): undefined | CompiledFunction<IArg<ArgType, boolean, boolean, EnumLike<any>>[], boolean>
Parameters
- fieldIndex: number
- ref: NativeFunction<IArg<ArgType, boolean, boolean, EnumLike<any>>[], boolean>
Returns undefined | CompiledFunction<IArg<ArgType, boolean, boolean, EnumLike<any>>[], boolean>
- Defined in src/structures/@internal/CompiledFunction.ts:552

getFunctions

getFunctions(fieldIndex, ref): CompiledFunction<IArg<ArgType, boolean, boolean, EnumLike<any>>[], boolean>[]
Parameters
- fieldIndex: number
- ref: NativeFunction<IArg<ArgType, boolean, boolean, EnumLike<any>>[], boolean>
Returns CompiledFunction<IArg<ArgType, boolean, boolean, EnumLike<any>>[], boolean>[]
- Defined in src/structures/@internal/CompiledFunction.ts:556

hasField

hasField(i): boolean
Parameters
- i: number
Returns boolean
- Defined in src/structures/@internal/CompiledFunction.ts:505

`Private` isValidReturnType

isValidReturnType(rt): boolean
Parameters
- rt: Return<ReturnType>
Returns boolean
- Defined in src/structures/@internal/CompiledFunction.ts:533

`Private` resolveApplicationEmoji

resolveApplicationEmoji(ctx, arg, str, ref): Promise<void | ApplicationEmoji>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns Promise<void | ApplicationEmoji>
- Defined in src/structures/@internal/CompiledFunction.ts:325

`Private` resolveArg

resolveArg(ctx, arg, field, value, ref): Promise<Return<ReturnType>>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- field: IExtendedCompiledFunctionField
- value: unknown
- ref: UnwrapArgs<T>
Returns Promise<Return<ReturnType>>
- Defined in src/structures/@internal/CompiledFunction.ts:471

`Private` resolveArgs

resolveArgs(ctx): Promise<Return<ReturnType>>
Resolves fields of a function.
Parameters
- ctx: Context
Returns Promise<Return<ReturnType>>
- Defined in src/structures/@internal/CompiledFunction.ts:119

`Private` resolveAttachment

resolveAttachment(ctx, arg, str, ref): Promise<AttachmentBuilder>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns Promise<AttachmentBuilder>
- Defined in src/structures/@internal/CompiledFunction.ts:357

`Private` resolveAutomodRule

resolveAutomodRule(ctx, arg, str, ref): undefined | Promise<void | AutoModerationRule>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<void | AutoModerationRule>
- Defined in src/structures/@internal/CompiledFunction.ts:381

`Private` resolveBigInt

resolveBigInt(ctx, arg, str, ref): bigint
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns bigint
- Defined in src/structures/@internal/CompiledFunction.ts:243

`Private` resolveBoolean

resolveBoolean(ctx, arg, str, ref): undefined | boolean
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | boolean
- Defined in src/structures/@internal/CompiledFunction.ts:276

`Private` resolveChannel

resolveChannel(ctx, arg, str, ref): undefined | Promise<null | Channel>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<null | Channel>
- Defined in src/structures/@internal/CompiledFunction.ts:287

`Private` resolveCode

resolveCode(ctx, __namedParameters?): Promise<Return<ReturnType>>
Parameters
- ctx: Context
- __namedParameters: Partial<Omit<IExtendedCompiledFunctionField, "value">> = {}
Returns Promise<Return<ReturnType>>
- Defined in src/structures/@internal/CompiledFunction.ts:214

`Private` resolveColor

resolveColor(ctx, arg, str, ref): number
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns number
- Defined in src/structures/@internal/CompiledFunction.ts:247

`Private` resolveCondition

resolveCondition(ctx, field): Promise<Return<ReturnType>>
Parameters
- ctx: Context
- field: IExtendedCompiledFunctionConditionField
Returns Promise<Return<ReturnType>>
- Defined in src/structures/@internal/CompiledFunction.ts:200

`Private` resolveDate

resolveDate(ctx, arg, str, ref): Date
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns Date
- Defined in src/structures/@internal/CompiledFunction.ts:462

`Private` resolveEmoji

resolveEmoji(ctx, arg, str, ref): Promise<void | GuildEmoji | ApplicationEmoji>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns Promise<void | GuildEmoji | ApplicationEmoji>
- Defined in src/structures/@internal/CompiledFunction.ts:335

`Private` resolveEnum

resolveEnum(ctx, arg, str, ref): any
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns any
- Defined in src/structures/@internal/CompiledFunction.ts:272

`Private` resolveForumTag

resolveForumTag(ctx, arg, str, ref): undefined | GuildForumTag
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | GuildForumTag
- Defined in src/structures/@internal/CompiledFunction.ts:345

`Private` resolveGuild

resolveGuild(ctx, arg, str, ref): undefined | Guild
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Guild
- Defined in src/structures/@internal/CompiledFunction.ts:298

`Private` resolveGuildEmoji

resolveGuildEmoji(ctx, arg, str, ref): undefined | GuildEmoji
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | GuildEmoji
- Defined in src/structures/@internal/CompiledFunction.ts:316

`Private` resolveInvite

resolveInvite(ctx, arg, str, ref): undefined | Promise<void | Invite>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<void | Invite>
- Defined in src/structures/@internal/CompiledFunction.ts:426

`Private` resolveJson

resolveJson(ctx, arg, str, ref): any
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns any
- Defined in src/structures/@internal/CompiledFunction.ts:302

`Private` resolveMember

resolveMember(ctx, arg, str, ref): undefined | Promise<void | GuildMember>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<void | GuildMember>
- Defined in src/structures/@internal/CompiledFunction.ts:376

`Private` resolveMessage

resolveMessage(ctx, arg, str, ref): undefined | Promise<void | Message<true>>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<void | Message<true>>
- Defined in src/structures/@internal/CompiledFunction.ts:280

`Private` resolveMultipleArgs

resolveMultipleArgs<X>(ctx, ...indexes): Promise<IMultipleArgResolve<T, X>>
Type Parameters
- X extends number[]
Parameters
- ctx: Context
- Rest ...indexes: [...X[]]
Returns Promise<IMultipleArgResolve<T, X>>
- Defined in src/structures/@internal/CompiledFunction.ts:134

`Private` resolveNumber

resolveNumber(ctx, arg, str, ref): undefined | number
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | number
- Defined in src/structures/@internal/CompiledFunction.ts:237

`Private` resolveOverwritePermission

resolveOverwritePermission(ctx, arg, str, ref): undefined | OverwritePermission
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | OverwritePermission
- Defined in src/structures/@internal/CompiledFunction.ts:440

`Private` resolvePermission

resolvePermission(ctx, arg, str, ref): undefined | string
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | string
- Defined in src/structures/@internal/CompiledFunction.ts:251

`Private` resolvePointer

resolvePointer<T>(arg, ref, fallback?): undefined | T
Type Parameters
- T
Parameters
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- ref: unknown[]
- Optional fallback: T
Returns undefined | T
- Defined in src/structures/@internal/CompiledFunction.ts:466

`Private` resolveReaction

resolveReaction(ctx, arg, str, ref): Promise<undefined | MessageReaction>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns Promise<undefined | MessageReaction>
- Defined in src/structures/@internal/CompiledFunction.ts:405

`Private` resolveRole

resolveRole(ctx, arg, str, ref): undefined | Role
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Role
- Defined in src/structures/@internal/CompiledFunction.ts:458

`Private` resolveRoleOrUser

resolveRoleOrUser(ctx, arg, str, ref): undefined | Role | Promise<void | User>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Role | Promise<void | User>
- Defined in src/structures/@internal/CompiledFunction.ts:311

`Private` resolveScheduledEvent

resolveScheduledEvent(ctx, arg, str, ref): undefined | Promise<void | GuildScheduledEvent<GuildScheduledEventStatus>>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<void | GuildScheduledEvent<GuildScheduledEventStatus>>
- Defined in src/structures/@internal/CompiledFunction.ts:386

`Private` resolveSoundboardSound

resolveSoundboardSound(ctx, arg, str, ref): undefined | Promise<void | GuildSoundboardSound>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<void | GuildSoundboardSound>
- Defined in src/structures/@internal/CompiledFunction.ts:391

`Private` resolveStageInstance

resolveStageInstance(ctx, arg, str, ref): undefined | StageInstance
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | StageInstance
- Defined in src/structures/@internal/CompiledFunction.ts:396

`Private` resolveSticker

resolveSticker(ctx, arg, str, ref): undefined | Promise<void | Sticker>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<void | Sticker>
- Defined in src/structures/@internal/CompiledFunction.ts:349

`Private` resolveString

resolveString(ctx, arg, str, ref): string
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns string
- Defined in src/structures/@internal/CompiledFunction.ts:256

`Private` resolveTemplate

resolveTemplate(ctx, arg, str, ref): Promise<void | GuildTemplate>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns Promise<void | GuildTemplate>
- Defined in src/structures/@internal/CompiledFunction.ts:436

`Private` resolveTextChannel

resolveTextChannel(ctx, arg, str, ref): Promise<undefined | DMChannel | PartialDMChannel | PartialGroupDMChannel | NewsChannel | StageChannel | TextChannel | PublicThreadChannel<boolean> | PrivateThreadChannel | VoiceChannel>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns Promise<undefined | DMChannel | PartialDMChannel | PartialGroupDMChannel | NewsChannel | StageChannel | TextChannel | PublicThreadChannel<boolean> | PrivateThreadChannel | VoiceChannel>
- Defined in src/structures/@internal/CompiledFunction.ts:292

`Private` resolveTime

resolveTime(ctx, arg, str, ref): undefined | number
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | number
- Defined in src/structures/@internal/CompiledFunction.ts:264

`Private` resolveURL

resolveURL(ctx, arg, str, ref): undefined | string
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | string
- Defined in src/structures/@internal/CompiledFunction.ts:413

`Private` resolveUnhandledArg

resolveUnhandledArg(ctx, i, ref?): Promise<Return<ReturnType>>
Does not account for condition fields.
Parameters
- ctx: Context
- i: number
- ref: any[] = []
Returns Promise<Return<ReturnType>>
- Defined in src/structures/@internal/CompiledFunction.ts:163

`Private` resolveUser

resolveUser(ctx, arg, str, ref): undefined | Promise<void | User>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<void | User>
- Defined in src/structures/@internal/CompiledFunction.ts:306

`Private` resolveWebhook

resolveWebhook(ctx, arg, str, ref): undefined | Promise<void | Webhook<WebhookType>>
Parameters
- ctx: Context
- arg: IArg<ArgType, boolean, boolean, EnumLike<any>>
- str: string
- ref: unknown[]
Returns undefined | Promise<void | Webhook<WebhookType>>
- Defined in src/structures/@internal/CompiledFunction.ts:431

return

return(value): Return<Return>
Parameters
- value: string
Returns Return<Return>
- Defined in src/structures/@internal/CompiledFunction.ts:564

stop

stop(): Return<Stop>
Returns Return<Stop>
- Defined in src/structures/@internal/CompiledFunction.ts:568

success

success(value?): Return<Success>
Parameters
- value: unknown = null
Returns Return<Success>
- Defined in src/structures/@internal/CompiledFunction.ts:592

successFormatted

successFormatted(value): Return<Success>
Parameters
- value: unknown
Returns Return<Success>
- Defined in src/structures/@internal/CompiledFunction.ts:584

successJSON

successJSON(value): Return<Success>
Parameters
- value: unknown
Returns Return<Success>
- Defined in src/structures/@internal/CompiledFunction.ts:580

unsafeSuccess

unsafeSuccess(value?): Return<Success>
Parameters
- value: unknown = null
Returns Return<Success>
- Defined in src/structures/@internal/CompiledFunction.ts:588

`Static` toResolveArgString

toResolveArgString(type): "resolveURL" | "resolveString" | "resolveBigInt" | "resolveUnknown" | "resolveTextChannel" | "resolveOverwritePermission" | "resolveNumber" | "resolveUser" | "resolveDate" | "resolveGuild" | "resolveRoleOrUser" | "resolveInvite" | "resolvePermission" | "resolveJson" | "resolveColor" | "resolveEnum" | "resolveForumTag" | "resolveEmoji" | "resolveGuildEmoji" | "resolveBoolean" | "resolveAttachment" | "resolveReaction" | "resolveMessage" | "resolveChannel" | "resolveRole" | "resolveWebhook" | "resolveSticker" | "resolveTime" | "resolveMember" | "resolveApplicationEmoji" | "resolveAutomodRule" | "resolveScheduledEvent" | "resolveStageInstance" | "resolveSoundboardSound" | "resolveTemplate"
Parameters
- type: ArgType
Returns "resolveURL" | "resolveString" | "resolveBigInt" | "resolveUnknown" | "resolveTextChannel" | "resolveOverwritePermission" | "resolveNumber" | "resolveUser" | "resolveDate" | "resolveGuild" | "resolveRoleOrUser" | "resolveInvite" | "resolvePermission" | "resolveJson" | "resolveColor" | "resolveEnum" | "resolveForumTag" | "resolveEmoji" | "resolveGuildEmoji" | "resolveBoolean" | "resolveAttachment" | "resolveReaction" | "resolveMessage" | "resolveChannel" | "resolveRole" | "resolveWebhook" | "resolveSticker" | "resolveTime" | "resolveMember" | "resolveApplicationEmoji" | "resolveAutomodRule" | "resolveScheduledEvent" | "resolveStageInstance" | "resolveSoundboardSound" | "resolveTemplate"
- Defined in src/structures/@internal/CompiledFunction.ts:548

Class CompiledFunction<T, Unwrap>

Type Parameters

T extends [...IArg[]] = IArg[]

Unwrap extends boolean = boolean

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends IArg<ArgType, boolean, boolean, EnumLike<any>>[] = IArg<ArgType, boolean, boolean, EnumLike<any>>[]

Unwrap extends boolean = boolean

Parameters

raw: ICompiledFunction

Returns CompiledFunction<T, Unwrap>

Properties

Readonly data

Readonly fn

Static Readonly CDNIdRegex

Static Readonly IdRegex

Static Readonly OverwriteSymbolMapping

Type declaration

+: boolean

-: boolean

/: null

Static Readonly URLRegex

Accessors

display

Returns string

hasFields

Returns boolean

Private resolveUnknown

Returns ((ctx, arg, str, ref) => string)

Parameters

ctx: Context

arg: IArg<ArgType, boolean, boolean, EnumLike<any>>

str: string

ref: unknown[]

Returns string

Methods

Private argTypeRejection

Parameters

arg: IArg<ArgType, boolean, boolean, EnumLike<any>>

value: unknown

Returns Return<Error>

break

Returns Return<Break>

continue

Returns Return<Continue>

customError

Parameters

msg: string

Returns Return<Error>

displayField

Parameters

i: number

Returns null | string

error

Parameters

err: Error

Returns Return<Error>

Type Parameters

T extends ErrorType

Parameters

type: T

Rest ...args: GetErrorArgs<T>

Returns Return<Error>

execute

Parameters

ctx: Context

Returns Promise<Return<ReturnType>>

Private fail

Parameters

ctx: Context

Optional code: IExtendedCompiledFunctionField

Returns Promise<Return<ReturnType>>

getFunction

Parameters

`Readonly` data

`Readonly` fn

`Static` `Readonly` CDNIdRegex

`Static` `Readonly` IdRegex

`Static` `Readonly` OverwriteSymbolMapping

`Static` `Readonly` URLRegex

`Private` resolveUnknown

`Private` argTypeRejection

`Rest` ...args: GetErrorArgs<T>

`Private` fail

`Optional` code: IExtendedCompiledFunctionField

`Private` isValidReturnType

`Private` resolveApplicationEmoji

`Private` resolveArg

`Private` resolveArgs

`Private` resolveAttachment

`Private` resolveAutomodRule

`Private` resolveBigInt

`Private` resolveBoolean

`Private` resolveChannel