Match | TypePipe

Stores conditions and callbacks to execute with the given values.

Type parameters

Value
Context
Global
Result = never
Async = false

Hierarchy

Match

Index

Constructors

constructor

Methods

Constructors

constructor

new Match<Value, Context, Global, Result, Async>(): Match<Value, Context, Global, Result, Async>

Type parameters
- Value
- Context
- Global
- Result = never
- Async = false
Returns Match<Value, Context, Global, Result, Async>

Methods

compose

compose(): Function<Value, Async extends true ? Promise<Result> : Result, Context, Global>

Creates a pipeline function that will run all the conditions with the given values and will return the result of the called callback.

If any of the conditions or callbacks returns a Promise, the returned value will be wrapped in a Promise.

example

const fn = new Match()
    .on(
        (value, context, global) => value > 5,
        (value, context, global) => value / 2
    )
    .on(
        (value, context, global) => value < 5,
        (value, context, global) => value * 2
    )
    .otherwise((value, context, global) => 0)
    .compose();

fn(20, context, global); // 10
fn(2, context, global); // 4
fn(5, context, global); // 0

const asyncFn = new Match()
    .on(
        (value, context, global) => value > 5,
        async (value, context, global) => value / 2
    )
    .on(
        async (value, context, global) => value < 5,
        (value, context, global) => value * 2
    )
    .otherwise((value, context, global) => 0)
    .compose();

asyncFn(20, context, global); // Promise => 10
asyncFn(2, context, global); // Promise => 4
asyncFn(5, context, global); // Promise => 0

Returns Function<Value, Async extends true ? Promise<Result> : Result, Context, Global>

on

on<Next>(matcher: Function<Value, boolean, Context, Global>, pipeline: Function<Value, Next, Context, Global>): Match<Value, Context, Global, ExtendsNever<Result, Awaited<Next>, Result>, Persist<Async, IsPromise<Next>>>

- Defined in classes/Match/index.ts:53
Adds a condition and a callback that will be run if the condition matches.
example
```
const match = new Match()
    .on(
        (value, context, global) => value > 5,
        (value, context, global) => value / 2
    )
    .on(
        (value, context, global) => value < 5,
        (value, context, global) => value * 2
    );
```
Type parameters
- Next
Parameters
- matcher: Function<Value, boolean, Context, Global>
- pipeline: Function<Value, Next, Context, Global>
Returns Match<Value, Context, Global, ExtendsNever<Result, Awaited<Next>, Result>, Persist<Async, IsPromise<Next>>>

otherwise

otherwise<Next>(pipeline: Function<Value, Next, Context, Global>): Match<Value, Context, Global, ExtendsNever<Result, Awaited<Next>, Result>, Persist<Async, IsPromise<Next>>>

- Defined in classes/Match/index.ts:81
Adds a callback that will be called if no conditions match.
example
```
const match = new Match()
    .on(
        (value, context, global) => value > 5,
        (value, context, global) => value / 2
    )
    .otherwise((value, context, global) => value * 2);
```
Type parameters
- Next
Parameters
- pipeline: Function<Value, Next, Context, Global>
Returns Match<Value, Context, Global, ExtendsNever<Result, Awaited<Next>, Result>, Persist<Async, IsPromise<Next>>>

run

run(value: Value, context: Context, global: Global): Async extends true ? Promise<Result> : Result

Calls the composed function from Match.compose with the given values and returns the result.

see

Match#compose

example

const match = new Match()
    .on(
        (value, context, global) => value > 5,
        (value, context, global) => value / 2
    )
    .on(
        (value, context, global) => value < 5,
        (value, context, global) => value * 2
    )
    .otherwise((value, context, global) => 0);

match.run(20, context, global); // 10
match.run(2, context, global); // 4
match.run(5, context, global); // 0

const asyncMatch = new Match()
    .on(
        (value, context, global) => value > 5,
        async (value, context, global) => value / 2
    )
    .on(
        async (value, context, global) => value < 5,
        (value, context, global) => value * 2
    )
    .otherwise((value, context, global) => 0);

asyncMatch.run(20, context, global); // Promise => 10
asyncMatch.run(2, context, global); // Promise => 4
asyncMatch.run(5, context, global); // Promise => 0

Parameters

value: Value
context: Context
global: Global

Type parameters

Value

Context

Global

Result = never

Async = false

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type parameters

Value

Context

Global

Result = never

Async = false

Returns Match<Value, Context, Global, Result, Async>

Methods

compose

Returns Function<Value, Async extends true ? Promise<Result> : Result, Context, Global>

on

Type parameters

Next

Parameters

matcher: Function<Value, boolean, Context, Global>

pipeline: Function<Value, Next, Context, Global>

Returns Match<Value, Context, Global, ExtendsNever<Result, Awaited<Next>, Result>, Persist<Async, IsPromise<Next>>>

otherwise

Type parameters

Next

Parameters

pipeline: Function<Value, Next, Context, Global>

Returns Match<Value, Context, Global, ExtendsNever<Result, Awaited<Next>, Result>, Persist<Async, IsPromise<Next>>>

run

Parameters

value: Value

context: Context

global: Global

Returns Async extends true ? Promise<Result> : Result