Class TextBranch

Text branch uses basic regex matching

Hierarchy

Branch
Branch
- TextBranch
  - TextDirectBranch

Implements

IBranch
IBranch

Indexable

[key: string]: any

Text branch uses basic regex matching

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TextBranch(input: Conditions | ConditionInput, callback: action, options?: IBranch): TextBranch

Overrides Branch.constructor
- Defined in lib/components/branch.d.ts:51
Create text branch for regex pattern Create text branch for regex pattern

Parameters
- input: Conditions | ConditionInput
- callback: action
- Optional options: IBranch
Returns TextBranch

Properties

callback

callback: ICallback

conditions

conditions: Conditions

force

force: boolean

id

id: string

Optional match

match: any

Optional matched

matched: undefined | false | true

processKey

processKey: ProcessKeys = "listen"

type

type: string

Methods

execute

execute(b: State, middleware: Middleware, done?: IDone): Promise<State>

Inherited from Branch.execute

Overrides Branch.execute
- Defined in lib/components/branch.d.ts:37
Parameters
- b: State
- middleware: Middleware
- Optional done: IDone
Returns Promise<State>

matcher

matcher(msg: Message): Promise<boolean | RegExpMatchArray | undefined>

Overrides Branch.matcher
- Defined in lib/components/branch.d.ts:53
Match message text against regex or composite conditions. Resolves with either single match result or cumulative condition success.

Parameters
- msg: Message
Returns Promise<boolean | RegExpMatchArray | undefined>

Generated using TypeDoc