Class PushRule<V>

Generic DSL support for returning an object on a push

Type parameters

V = any

Hierarchy

PushRule
- GoalSetterMapping

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PushRule(guard1: PushTest, guards: PushTest[], reason?: string): PushRule

- Defined in lib/api/mapping/support/PushRule.ts:49
Parameters
- guard1: PushTest
- guards: PushTest[]
- Optional reason: string
Returns PushRule

Properties

Protected guard1

guard1: PushTest

Protected guards

guards: PushTest[]

Readonly pushTest

pushTest: PushTest

The test for this rule

Private reason

reason: string

Private staticValue

staticValue: V

Accessors

name

get name(): string

- Defined in lib/api/mapping/support/PushRule.ts:36
Returns string

test

get test(): PushTest

- Defined in lib/api/mapping/support/PushRule.ts:45
Returns PushTest

value

get value(): V

- Defined in lib/api/mapping/support/PushRule.ts:32
Returns V

Methods

itMeans

itMeans(reason: string): this

- Defined in lib/api/mapping/support/PushRule.ts:62
Set an additional reason if we want to add information to that which is available from the push tests themselves

Parameters
- reason: string
Returns this

mapping

mapping(p: PushListenerInvocation): Promise<V | undefined>

- Defined in lib/api/mapping/support/PushRule.ts:77
Parameters
- p: PushListenerInvocation
Returns Promise<V | undefined>

set

set(value: V): this

- Defined in lib/api/mapping/support/PushRule.ts:72
Set the value that will be resolved from this rule

Parameters
- value: V
Returns this

Generated using TypeDoc