pipe

Properties

async

readonly async: {<A>(a): Promise<A>; <A, B>(a, ab): Promise<B>; <A, B, C>(a, ab, bc): Promise<C>; <A, B, C, D>(a, ab, bc, cd): Promise<D>; <A, B, C, D, E>(a, ab, bc, cd, de): Promise<E>; <A, B, C, D, E, F>(a, ab, bc, cd, de, ef): Promise<F>; <A, B, C, D, E, F, G>(a, ab, bc, cd, de, ef, fg): Promise<G>; <A, B, C, D, E, F, G, H>(a, ab, bc, cd, de, ef, fg, gh): Promise<H>; <A, B, C, D, E, F, G, H, I>(a, ab, bc, cd, de, ef, fg, gh, hi): Promise<I>; <A, B, C, D, E, F, G, H, I, J>(a, ab, bc, cd, de, ef, fg, gh, hi, ij): Promise<J>; <A, B, C, D, E, F, G, H, I, J, K>(a, ab, bc, cd, de, ef, fg, gh, hi, ij, jk): Promise<K>; }

Defined in: Composition/pipe.ts:392

Pipes a value through a sequence of operations, supporting asynchronous transitions at any step.

Call Signature

<A>(a): Promise<A>

Type Parameters

A

A

Parameters

a

A | Promise<A>

Returns

Promise<A>

Call Signature

<A, B>(a, ab): Promise<B>

Type Parameters

A

A

B

B

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

Returns

Promise<B>

Call Signature

<A, B, C>(a, ab, bc): Promise<C>

Type Parameters

A

A

B

B

C

C

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

bc

(b) => C | Promise<C>

Returns

Promise<C>

Call Signature

<A, B, C, D>(a, ab, bc, cd): Promise<D>

Type Parameters

A

A

B

B

C

C

D

D

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

bc

(b) => C | Promise<C>

cd

(c) => D | Promise<D>

Returns

Promise<D>

Call Signature

<A, B, C, D, E>(a, ab, bc, cd, de): Promise<E>

Type Parameters

A

A

B

B

C

C

D

D

E

E

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

bc

(b) => C | Promise<C>

cd

(c) => D | Promise<D>

de

(d) => E | Promise<E>

Returns

Promise<E>

Call Signature

<A, B, C, D, E, F>(a, ab, bc, cd, de, ef): Promise<F>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

bc

(b) => C | Promise<C>

cd

(c) => D | Promise<D>

de

(d) => E | Promise<E>

ef

(e) => F | Promise<F>

Returns

Promise<F>

Call Signature

<A, B, C, D, E, F, G>(a, ab, bc, cd, de, ef, fg): Promise<G>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

bc

(b) => C | Promise<C>

cd

(c) => D | Promise<D>

de

(d) => E | Promise<E>

ef

(e) => F | Promise<F>

fg

(f) => G | Promise<G>

Returns

Promise<G>

Call Signature

<A, B, C, D, E, F, G, H>(a, ab, bc, cd, de, ef, fg, gh): Promise<H>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

H

H

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

bc

(b) => C | Promise<C>

cd

(c) => D | Promise<D>

de

(d) => E | Promise<E>

ef

(e) => F | Promise<F>

fg

(f) => G | Promise<G>

gh

(g) => H | Promise<H>

Returns

Promise<H>

Call Signature

<A, B, C, D, E, F, G, H, I>(a, ab, bc, cd, de, ef, fg, gh, hi): Promise<I>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

H

H

I

I

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

bc

(b) => C | Promise<C>

cd

(c) => D | Promise<D>

de

(d) => E | Promise<E>

ef

(e) => F | Promise<F>

fg

(f) => G | Promise<G>

gh

(g) => H | Promise<H>

hi

(h) => I | Promise<I>

Returns

Promise<I>

Call Signature

<A, B, C, D, E, F, G, H, I, J>(a, ab, bc, cd, de, ef, fg, gh, hi, ij): Promise<J>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

H

H

I

I

J

J

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

bc

(b) => C | Promise<C>

cd

(c) => D | Promise<D>

de

(d) => E | Promise<E>

ef

(e) => F | Promise<F>

fg

(f) => G | Promise<G>

gh

(g) => H | Promise<H>

hi

(h) => I | Promise<I>

ij

(i) => J

Returns

Promise<J>

Call Signature

<A, B, C, D, E, F, G, H, I, J, K>(a, ab, bc, cd, de, ef, fg, gh, hi, ij, jk): Promise<K>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

H

H

I

I

J

J

K

K

Parameters

a

A | Promise<A>

ab

(a) => B | Promise<B>

bc

(b) => C | Promise<C>

cd

(c) => D | Promise<D>

de

(d) => E | Promise<E>

ef

(e) => F | Promise<F>

fg

(f) => G | Promise<G>

gh

(g) => H | Promise<H>

hi

(h) => I | Promise<I>

ij

(i) => J | Promise<J>

jk

(j) => K | Promise<K>

Returns

Promise<K>

either

readonly either: <A, B>(predicate, onTrue, onFalse) => (a) => B

Defined in: Composition/pipe.ts:371

Executes one of two functions based on a predicate, acting as a functional if-else/ternary helper.

Type Parameters

A

A

B

B

Parameters

predicate

(a) => boolean

onTrue

(a) => B

onFalse

(a) => B

Returns

(a) => B

safe

readonly safe: {<A>(a): A; <A, B>(a, ab): B | Extract<A, null | undefined>; <A, B, C>(a, ab, bc): C | Extract<A, null | undefined> | Extract<B, null | undefined>; <A, B, C, D>(a, ab, bc, cd): D | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined>; <A, B, C, D, E>(a, ab, bc, cd, de): E | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined>; <A, B, C, D, E, F>(a, ab, bc, cd, de, ef): F | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined>; <A, B, C, D, E, F, G>(a, ab, bc, cd, de, ef, fg): G | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined>; <A, B, C, D, E, F, G, H>(a, ab, bc, cd, de, ef, fg, gh): H | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined> | Extract<G, null | undefined>; <A, B, C, D, E, F, G, H, I>(a, ab, bc, cd, de, ef, fg, gh, hi): I | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined> | Extract<G, null | undefined> | Extract<H, null | undefined>; <A, B, C, D, E, F, G, H, I, J>(a, ab, bc, cd, de, ef, fg, gh, hi, ij): J | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined> | Extract<G, null | undefined> | Extract<H, null | undefined> | Extract<I, null | undefined>; <A, B, C, D, E, F, G, H, I, J, K>(a, ab, bc, cd, de, ef, fg, gh, hi, ij, jk): K | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined> | Extract<G, null | undefined> | Extract<H, null | undefined> | Extract<I, null | undefined> | Extract<J, null | undefined>; }

Defined in: Composition/pipe.ts:387

Pipes a value through a sequence of operations, short-circuiting and propagating null or undefined immediately if any intermediate step evaluates to nil.

Call Signature

<A>(a): A

Type Parameters

A

A

Parameters

a

A

Returns

A

Call Signature

<A, B>(a, ab): B | Extract<A, null | undefined>

Type Parameters

A

A

B

B

Parameters

a

A

ab

(a) => B

Returns

B | Extract<A, null | undefined>

Call Signature

<A, B, C>(a, ab, bc): C | Extract<A, null | undefined> | Extract<B, null | undefined>

Type Parameters

A

A

B

B

C

C

Parameters

a

A

ab

(a) => B

bc

(b) => C

Returns

C | Extract<A, null | undefined> | Extract<B, null | undefined>

Call Signature

<A, B, C, D>(a, ab, bc, cd): D | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined>

Type Parameters

A

A

B

B

C

C

D

D

Parameters

a

A

ab

(a) => B

bc

(b) => C

cd

(c) => D

Returns

Call Signature

<A, B, C, D, E>(a, ab, bc, cd, de): E | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined>

Type Parameters

A

A

B

B

C

C

D

D

E

E

Parameters

a

A

ab

(a) => B

bc

(b) => C

cd

(c) => D

de

(d) => E

Returns

Call Signature

<A, B, C, D, E, F>(a, ab, bc, cd, de, ef): F | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

Parameters

a

A

ab

(a) => B

bc

(b) => C

cd

(c) => D

de

(d) => E

ef

(e) => F

Returns

Call Signature

<A, B, C, D, E, F, G>(a, ab, bc, cd, de, ef, fg): G | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

Parameters

a

A

ab

(a) => B

bc

(b) => C

cd

(c) => D

de

(d) => E

ef

(e) => F

fg

(f) => G

Returns

Call Signature

<A, B, C, D, E, F, G, H>(a, ab, bc, cd, de, ef, fg, gh): H | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined> | Extract<G, null | undefined>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

H

H

Parameters

a

A

ab

(a) => B

bc

(b) => C

cd

(c) => D

de

(d) => E

ef

(e) => F

fg

(f) => G

gh

(g) => H

Returns

Call Signature

<A, B, C, D, E, F, G, H, I>(a, ab, bc, cd, de, ef, fg, gh, hi): I | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined> | Extract<G, null | undefined> | Extract<H, null | undefined>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

H

H

I

I

Parameters

a

A

ab

(a) => B

bc

(b) => C

cd

(c) => D

de

(d) => E

ef

(e) => F

fg

(f) => G

gh

(g) => H

hi

(h) => I

Returns

Call Signature

<A, B, C, D, E, F, G, H, I, J>(a, ab, bc, cd, de, ef, fg, gh, hi, ij): J | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined> | Extract<G, null | undefined> | Extract<H, null | undefined> | Extract<I, null | undefined>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

H

H

I

I

J

J

Parameters

a

A

ab

(a) => B

bc

(b) => C

cd

(c) => D

de

(d) => E

ef

(e) => F

fg

(f) => G

gh

(g) => H

hi

(h) => I

ij

(i) => J

Returns

Call Signature

<A, B, C, D, E, F, G, H, I, J, K>(a, ab, bc, cd, de, ef, fg, gh, hi, ij, jk): K | Extract<A, null | undefined> | Extract<B, null | undefined> | Extract<C, null | undefined> | Extract<D, null | undefined> | Extract<E, null | undefined> | Extract<F, null | undefined> | Extract<G, null | undefined> | Extract<H, null | undefined> | Extract<I, null | undefined> | Extract<J, null | undefined>

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

H

H

I

I

J

J

K

K

Parameters

a

A

ab

(a) => B

bc

(b) => C

cd

(c) => D

de

(d) => E

ef

(e) => F

fg

(f) => G

gh

(g) => H

hi

(h) => I

ij

(i) => J

jk

(j) => K

Returns

struct

readonly struct: <A, R>(fields) => (a) => R

Defined in: Composition/pipe.ts:381

Builds an object by applying a record of field-level transformer functions to the piped input.

Type Parameters

A

A

R

R extends Record<string, unknown>

Parameters

fields

{ [K in string | number | symbol]: (a: A) => R[K] }

Returns

(a) => R

try

readonly try: <A, B, C>(f, onError) => (a) => B | C

Defined in: Composition/pipe.ts:376

Creates a pipeline step that wraps a throwing function in a try/catch, returning a fallback value if an error occurs.

Type Parameters

A

A

B

B

C

C

Parameters

f

(a) => B

onError

(error, value) => C

Returns

(a) => B | C

unless

readonly unless: <A>(predicate, onFalse) => (a) => A

Defined in: Composition/pipe.ts:366

Executes a function on the piped value if a predicate is NOT met, otherwise returns the value unchanged.

Type Parameters

A

A

Parameters

predicate

(a) => boolean

onFalse

(a) => A

Returns

(a) => A

when

readonly when: <A>(predicate, onTrue) => (a) => A

Defined in: Composition/pipe.ts:361

Executes a function on the piped value if a predicate is met, otherwise returns the value unchanged.

Type Parameters

A

A

Parameters

predicate

(a) => boolean

onTrue

(a) => A

Returns

(a) => A