Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextBranch

Text branch uses basic regex matching

Hierarchy

Indexable

[key: string]: any

Text branch uses basic regex matching

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

callback

callback: IBranchCallback

conditions

conditions: Conditions

force

force: boolean = false

id

id: string

Optional match

match: any

Optional matched

matched: undefined | true | false

Methods

matcher

  • matcher(message: Message): Promise<any>
  • Match message text against regex or composite conditions. Resolves with either single match result or cumulative condition success.

    Parameters

    Returns Promise<any>

process

  • Runs the matcher, then middleware and callback if matched. Middleware can intercept and prevent the callback from executing. If the state has already matched on prior branch, it will not match again unless forced to, with the branch's force property.

    Parameters

    • b: State

      State containing message to process

    • middleware: Middleware

      Executes before the branch callback if matched

    • Default value done: IBranchDone = () => null

      Called after middleware (optional), with match status

    Returns Promise<State>

Generated using TypeDoc