Class ServerBranch

Server branch matches data in a message received on the server.

Hierarchy

Branch
Branch
- ServerBranch

Implements

IBranch
IBranch

Indexable

[key: string]: any

Server branch matches data in a message received on the server.

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ServerBranch(criteria: IServerBranchCriteria, callback: action, options?: IBranch): ServerBranch

Overrides Branch.constructor
- Defined in lib/components/branch.d.ts:76
Create server branch for data matching. Create server branch for data matching.

Parameters
- criteria: IServerBranchCriteria
- callback: action
- Optional options: IBranch
Returns ServerBranch

Properties

callback

callback: ICallback

criteria

criteria: IServerBranchCriteria

force

force: boolean

id

id: string

match

match: any

Optional matched

matched: undefined | false | true

processKey

processKey: ProcessKeys = "serve"

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: ServerMessage): Promise<object | undefined>

Overrides Branch.matcher
- Defined in lib/components/branch.d.ts:78
Match on any exact or regex values at path of key in criteria. Will also match on empty data if criteria is an empty object.

Parameters
- msg: ServerMessage
Returns Promise<object | undefined>

Generated using TypeDoc