Class Context

constructor

• new Context(runtime: IRunnable): Context

  Parameters

  • runtime: IRunnable

  Returns Context

automodRule

Optionalcalendar

component

container

executionTimestamp

http

OptionalpermissionOverwrites

Readonlyruntime

scheduledEvent

timezone

args

• get args(): string[]

  Returns string[]

automod

• get automod(): AutoModerationActionExecution | null

  Returns AutoModerationActionExecution | null

channel

• get channel(): | BaseChannel
  | CategoryChannel
  | NewsChannel
  | StageChannel
  | TextChannel
  | PublicThreadChannel<boolean>
  | PrivateThreadChannel
  | VoiceChannel
  | ForumChannel
  | MediaChannel
  | null

  Returns
      | BaseChannel
      | CategoryChannel
      | NewsChannel
      | StageChannel
      | TextChannel
      | PublicThreadChannel<boolean>
      | PrivateThreadChannel
      | VoiceChannel
      | ForumChannel
      | MediaChannel
      | null

client

• get client(): ForgeClient

  Returns ForgeClient

cmd

• get cmd(): BaseCommand<unknown> | null

  Returns BaseCommand<unknown> | null

emoji

• get emoji(): Emoji | null

  Returns Emoji | null

entitlement

• get entitlement(): Entitlement | null

  Returns Entitlement | null

getExtension

• get getExtension(): {
      <B extends boolean>(
          name: string,
          required?: B,
      ): B extends true ? ForgeExtension : ForgeExtension | null;
      <T extends ClassType, B extends boolean>(
          type: string | T,
          required?: B,
      ): B extends true ? ClassInstance<T> : ClassInstance<T> | null;
  }

  Returns {
      <B extends boolean>(
          name: string,
          required?: B,
      ): B extends true ? ForgeExtension : ForgeExtension | null;
      <T extends ClassType, B extends boolean>(
          type: string | T,
          required?: B,
      ): B extends true ? ClassInstance<T> : ClassInstance<T> | null;
  }

guild

• get guild(): Guild | null

  Returns Guild | null

interaction

• get interaction(): Interaction | null

  Returns Interaction | null

member

• get member(): GuildMember | null

  Returns GuildMember | null

message

• get message(): Message<any> | null

  Returns Message<any> | null

noop

• get noop(): (...args: any[]) => void

  Returns (...args: any[]) => void

obj

• get obj(): Sendable

  Returns Sendable

• set obj(o: Sendable): void

  Parameters

  • o: Sendable

  Returns void

reaction

• get reaction(): MessageReaction | null

  Returns MessageReaction | null

reason

• get reason(): string | undefined

  Returns string | undefined

• set reason(str: string | undefined): void

  Parameters

  • str: string | undefined

  Returns void

role

• get role(): Role | null

  Returns Role | null

sound

• get sound(): SoundboardSound | null

  Returns SoundboardSound | null

states

• get states(): States | undefined

  Returns States | undefined

sticker

• get sticker(): Sticker | null

  Returns Sticker | null

subscription

• get subscription(): Subscription | null

  Returns Subscription | null

user

• get user(): User | null

  Returns User | null

alert

• alert(content: string): Promise<unknown>

  Parameters

  • content: string

  Returns Promise<unknown>

clearAutomodRuleOptions

• clearAutomodRuleOptions(): void

  Returns void

clearEnvironment

• clearEnvironment(): void

  Returns void

clearHttpOptions

• clearHttpOptions(): void

  Returns void

clearKeywords

• clearKeywords(): void

  Returns void

clearScheduledEventOptions

• clearScheduledEventOptions(): void

  Returns void

clone

• clone(props?: Partial<IRunnable>, syncVars?: boolean): Context

  Clones keywords, environment vars, and local functions.

  Parameters

  • Optionalprops: Partial<IRunnable>
  • syncVars: boolean = false

  Returns Context

cloneEmpty

• cloneEmpty(): Context

  Returns Context

cloneRuntime

• cloneRuntime(): IRunnable

  Returns IRunnable

deleteEnvironmentKey

• deleteEnvironmentKey(name: string): boolean

  Parameters

  • name: string

  Returns boolean

deleteKeyword

• deleteKeyword(name: string): boolean

  Parameters

  • name: string

  Returns boolean

deleteLocalFunction

• deleteLocalFunction(name: string): boolean

  Parameters

  • name: string

  Returns boolean

fetchApplicationEmojis

• fetchApplicationEmojis(
      once?: boolean,
  ): Promise<void | Collection<string, ApplicationEmoji>>

  Fetches all emojis of the application.

  Parameters

  • Optionalonce: boolean

    Whether to fetch only when the collection is empty.

  Returns Promise<void | Collection<string, ApplicationEmoji>>

get

• get<T>(key: PropertyKey): T

  Type Parameters

  • T

  Parameters

  • key: PropertyKey

  Returns T

getEnvironmentInstance

• getEnvironmentInstance<T extends ClassType>(
      type: T,
      ...keys: string[],
  ): ClassInstance<T> | null

  Type Parameters

  • T extends ClassType

  Parameters

  • type: T
  • ...keys: string[]

  Returns ClassInstance<T> | null

getEnvironmentKey

• getEnvironmentKey(...args: string[]): object | undefined

  Parameters

  • ...args: string[]

  Returns object | undefined

getInstance

• getInstance<K extends string, T extends ClassType>(
      key: K,
      type: T,
  ): (Context & { [P in "bro" as K]: ClassInstance<T> })[K] | null

  Type Parameters

  • K extends string
  • T extends ClassType

  Parameters

  • key: K
  • type: T

  Returns (Context & { [P in "bro" as K]: ClassInstance<T> })[K] | null

getKeyword

• getKeyword(name: string): unknown

  Parameters

  • name: string

  Returns unknown

getLocalFunction

• getLocalFunction(name: string): ILocalFunctionData

  Parameters

  • name: string

  Returns ILocalFunctionData

handle

• handle<
      Args extends IArg<ArgType, boolean, boolean, EnumLike<any>>[],
      Unwrap extends boolean,
  >(
      fn: CompiledFunction<Args, Unwrap>,
      cb: ExpectCallback<Args, Unwrap>,
  ): Promise<Return<ReturnType>>

  Type Parameters

  • Args extends IArg<ArgType, boolean, boolean, EnumLike<any>>[]
  • Unwrap extends boolean

  Parameters

  • fn: CompiledFunction<Args, Unwrap>
  • cb: ExpectCallback<Args, Unwrap>

  Returns Promise<Return<ReturnType>>

handleNotSuccess

• handleNotSuccess(fn: CompiledFunction, rt: Return): boolean

  Parameters

  • fn: CompiledFunction
  • rt: Return

  Returns boolean

hasDisabledConsoleErrors

• hasDisabledConsoleErrors(): boolean | undefined

  Returns boolean | undefined

hasInstance

• hasInstance<K extends string, V extends ClassType>(
      key: K,
      type: V,
  ): this is Context & { [P in "bro" as K]: ClassInstance<V> }

  Type Parameters

  • K extends string
  • V extends ClassType

  Parameters

  • key: K
  • type: V

  Returns this is Context & { [P in "bro" as K]: ClassInstance<V> }

hasKeyword

• hasKeyword(name: string): boolean

  Parameters

  • name: string

  Returns boolean

isCommand

• isCommand(): this is Context & {
      get interaction(): ChatInputCommandInteraction;
  }

  Returns this is Context & { get interaction(): ChatInputCommandInteraction }

isContextCommand

• isContextCommand(): this is Context & {
      get interaction(): ContextMenuCommandInteraction;
  }

  Returns this is Context & { get interaction(): ContextMenuCommandInteraction }

isSelectMenu

• isSelectMenu(): this is Context & {
      get interaction(): AnySelectMenuInteraction;
  }

  Returns this is Context & { get interaction(): AnySelectMenuInteraction }

setEnvironmentKey

• setEnvironmentKey(name: string, value: unknown): unknown

  Parameters

  • name: string
  • value: unknown

  Returns unknown

setKeyword

• setKeyword(name: string, value: unknown): unknown

  Parameters

  • name: string
  • value: unknown

  Returns unknown

setLocalFunction

• setLocalFunction(name: string, data: ILocalFunctionData): ILocalFunctionData

  Parameters

  • name: string
  • data: ILocalFunctionData

  Returns ILocalFunctionData

traverseAddEnvironmentKey

• traverseAddEnvironmentKey(value: unknown, ...keys: string[]): boolean

  Parameters

  • value: unknown
  • ...keys: string[]

  Returns boolean

traverseDeleteEnvironmentKey

• traverseDeleteEnvironmentKey(...keys: string[]): boolean | any[]

  Parameters

  • ...keys: string[]

  Returns boolean | any[]

StatictraverseGetValue

• traverseGetValue(previous: object, ...args: string[]): object | undefined

  Parameters

  • previous: object
  • ...args: string[]

  Returns object | undefined