Class Flag<T>

constructor

• new Flag<T extends FlagType = FlagType>(type: T & Cancel): Flag<T>

• Type Parameters

  • T extends FlagType = FlagType

  Parameters

  • type: T & Cancel

    Type of flag.

  Returns Flag<T>
• new Flag<T extends FlagType = FlagType>(
      type: T & Timeout,
      data?: FlagTimeoutData,
  ): Flag<T>

• Type Parameters

  • T extends FlagType = FlagType

  Parameters

  • type: T & Timeout
  • Optionaldata: FlagTimeoutData

  Returns Flag<T>

• new Flag<T extends FlagType = FlagType>(
      type: T & Retry,
      data?: FlagRetryData,
  ): Flag<T>

• Type Parameters

  • T extends FlagType = FlagType

  Parameters

  • type: T & Retry
  • Optionaldata: FlagRetryData

  Returns Flag<T>

• new Flag<T extends FlagType = FlagType>(
      type: T & Fail,
      data?: FlagFailData,
  ): Flag<T>

• Type Parameters

  • T extends FlagType = FlagType

  Parameters

  • type: T & Fail
  • Optionaldata: FlagFailData

  Returns Flag<T>

• new Flag<T extends FlagType = FlagType>(
      type: T & Continue,
      data?: FlagContinueData,
  ): Flag<T>

• Type Parameters

  • T extends FlagType = FlagType

  Parameters

  • type: T & Continue
  • Optionaldata: FlagContinueData

  Returns Flag<T>

command

ignore

message

rest

time

type

value

Staticcancel

• cancel(): Flag<Cancel>

• Creates a flag that cancels the command.

  Returns Flag<Cancel>

Staticcontinue

• continue(
      command: string,
      ignore?: boolean,
      rest?: null | string,
  ): Flag<Continue>

• Creates a flag that runs another command with the rest of the arguments.

  Parameters

  • command: string

    Command ID.
  • ignore: boolean = false

    Whether or not to ignore permission checks.
  • rest: null | string = null

    The rest of the arguments. If this is not set, the argument handler will automatically use the rest of the content.

  Returns Flag<Continue>

Staticfail

• fail(value: any): Flag<Fail>

• Creates a flag that acts as argument cast failure with extra data.

  Parameters

  • value: any

    The extra data for the failure.

  Returns Flag<Fail>

Staticis

• is<Type extends FlagType>(value: unknown, type: Type): value is Flag<Type>

• Checks if a value is a flag and of some type.

  Type Parameters

  • Type extends FlagType

  Parameters

  • value: unknown

    Value to check.
  • type: Type

    Type of flag.

  Returns value is Flag<Type>

Staticretry

• retry(message: TextCommandMessage): Flag<Retry>

• Creates a flag that retries with another input.

  Parameters

  • message: TextCommandMessage

    Message to handle.

  Returns Flag<Retry>

Statictimeout

• timeout(time: number): Flag<Timeout>

• Create a flag that cancels the command because of the timeout

  Parameters

  • time: number

  Returns Flag<Timeout>