Class ArgumentRunner

constructor

• new ArgumentRunner(command: Command): ArgumentRunner

• Parameters

  • command: Command

    Command to run for.

  Returns ArgumentRunner

command

client

• get client(): AkairoClient<boolean, AkairoClientEvents>

• The Akairo client.

  Returns AkairoClient<boolean, AkairoClientEvents>

handler

• get handler(): CommandHandler

• The command handler.

  Returns CommandHandler

run

• run(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      generator: (
          ...args: [
              message: TextCommandMessage,
              parsed: ContentParserResult,
              state: ArgumentRunnerState,
          ],
      ) => ArgumentGeneratorReturn,
  ): Promise<Flag<FlagType> | { [args: string]: unknown }>

• Runs the arguments.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • generator: (
        ...args: [
            message: TextCommandMessage,
            parsed: ContentParserResult,
            state: ArgumentRunnerState,
        ],
    ) => ArgumentGeneratorReturn

    Argument generator.

  Returns Promise<Flag<FlagType> | { [args: string]: unknown }>

runContent

• runContent(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): Promise<any>

• Runs content match.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns Promise<any>

runFlag

• runFlag(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): any

• Runs flag match.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns any

runNone

• runNone(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): Promise<any>

• Runs none match.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns Promise<any>

runOne

• runOne(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): Promise<any>

• Runs one argument.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns Promise<any>

runOption

• runOption(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): Promise<any>

• Runs option match.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns Promise<any>

runPhrase

• runPhrase(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): Promise<any>

• Runs phrase match.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns Promise<any>

runRest

• runRest(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): Promise<any>

• Runs rest match.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns Promise<any>

runRestContent

• runRestContent(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): Promise<any>

• Runs restContent match.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns Promise<any>

runSeparate

• runSeparate(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): Promise<any>

• Runs separate match.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns Promise<any>

runText

• runText(
      message: TextCommandMessage,
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      arg: Argument,
  ): Promise<any>

• Runs text match.

  Parameters

  • message: TextCommandMessage

    Message that triggered the command.
  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • arg: Argument

    Current argument.

  Returns Promise<any>

StaticfromArguments

• fromArguments(
      args: [id: string, argument: Argument][],
  ): () => ArgumentGeneratorReturn

• Creates an argument generator from argument options.

  Parameters

  • args: [id: string, argument: Argument][]

    Argument options.

  Returns () => ArgumentGeneratorReturn

StaticincreaseIndex

• increaseIndex(
      parsed: ContentParserResult,
      state: ArgumentRunnerState,
      n?: number,
  ): void

• Modifies state by incrementing the indices.

  Parameters

  • parsed: ContentParserResult

    Parsed data from ContentParser.
  • state: ArgumentRunnerState

    Argument handling state.
  • n: number = 1

    Number of indices to increase by.

  Returns void

StaticisShortCircuit

• isShortCircuit(
      value: unknown,
  ): value is Flag<Cancel> | Flag<Retry> | Flag<Continue>

• Checks if something is a flag that short circuits.

  Parameters

  • value: unknown

    A value.

  Returns value is Flag<Cancel> | Flag<Retry> | Flag<Continue>