Class CompiledFunction<T, Unwrap>

constructor

• new CompiledFunction<
      T extends
          IArg<ArgType, boolean, boolean, EnumLike<any>>[] = IArg<
          ArgType,
          boolean,
          boolean,
          EnumLike<any>,
      >[],
      Unwrap extends boolean = boolean,
  >(
      raw: ICompiledFunction,
  ): 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>

Readonlydata

Readonlyfn

Static ReadonlyCDNIdRegex

Static ReadonlyIdRegex

Static ReadonlyOverwriteSymbolMapping

Static ReadonlyURLRegex

display

• get display(): string

  Returns string

hasFields

• get hasFields(): boolean

  Returns boolean

break

• break(): Return<Break>

  Returns Return<Break>

continue

• continue(): Return<Continue>

  Returns Return<Continue>

customError

• customError(msg: string): Return<Error>

  Parameters

  • msg: string

  Returns Return<Error>

displayField

• displayField(i: number): string | null

  Parameters

  • i: number

  Returns string | null

error

• error(err: Error): Return<Error>

  Parameters

  • err: Error

  Returns Return<Error>

• error<T extends ErrorType>(type: T, ...args: GetErrorArgs<T>): Return<Error>

  Type Parameters

  • T extends ErrorType

  Parameters

  • type: T
  • ...args: GetErrorArgs<T>

  Returns Return<Error>

execute

• execute(ctx: Context): Promise<Return<ReturnType>>

  Parameters

  • ctx: Context

  Returns Promise<Return<ReturnType>>

getFunction

• getFunction(
      fieldIndex: number,
      ref: NativeFunction,
  ):
      | CompiledFunction<
          IArg<ArgType, boolean, boolean, EnumLike<any>>[],
          boolean,
      >
      | undefined

  Parameters

  • fieldIndex: number
  • ref: NativeFunction

  Returns
      | CompiledFunction<
          IArg<ArgType, boolean, boolean, EnumLike<any>>[],
          boolean,
      >
      | undefined

getFunctions

• getFunctions(
      fieldIndex: number,
      ref: NativeFunction,
  ): CompiledFunction<
      IArg<ArgType, boolean, boolean, EnumLike<any>>[],
      boolean,
  >[]

  Parameters

  • fieldIndex: number
  • ref: NativeFunction

  Returns CompiledFunction<IArg<ArgType, boolean, boolean, EnumLike<any>>[], boolean>[]

hasField

• hasField(i: number): boolean

  Parameters

  • i: number

  Returns boolean

return

• return(value: string): Return<Return>

  Parameters

  • value: string

  Returns Return<Return>

stop

• stop(): Return<Stop>

  Returns Return<Stop>

success

• success(value?: unknown): Return<Success>

  Parameters

  • value: unknown = null

  Returns Return<Success>

successFormatted

• successFormatted(value: unknown): Return<Success>

  Parameters

  • value: unknown

  Returns Return<Success>

successJSON

• successJSON(value: unknown): Return<Success>

  Parameters

  • value: unknown

  Returns Return<Success>

unsafeSuccess

• unsafeSuccess(value?: unknown): Return<Success>

  Parameters

  • value: unknown = null

  Returns Return<Success>

StatictoResolveArgString

• toResolveArgString(
      type: ArgType,
  ):
      | "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"