Class Gated<X>

Function that executes conditionally based on the result of another function.

Type parameters

X

Hierarchy

Gated

Implements

any

Index

Constructors

constructor

Methods

Constructors

constructor

new Gated(condition: FunctionLike<X, ScalarLike<boolean>>, func: FunctionLike<X, void>, toBool?: UnaryFunction<ScalarLike<boolean>, boolean>): Gated

- Defined in function/Gated.ts:26
Ctor.

Parameters
- condition: FunctionLike<X, ScalarLike<boolean>>
  
  Condition.
- func: FunctionLike<X, void>
  
  Function.
- Default value toBool: UnaryFunction<ScalarLike<boolean>, boolean> = new ToValue()
Returns Gated

Methods

apply

apply(input: X): void

- Defined in function/Gated.ts:54
Apply the function to the input.

Parameters
- input: X
  
  Input.
Returns void

isFunction

isFunction(): true

- Defined in function/Gated.ts:46
Type determinant.

Returns true

Generated using TypeDoc