"async/index" | @quenk/preconditions

Index

Interfaces

Preconditions

Type aliases

Precondition

Variables

id

Functions

Type aliases

Precondition

Precondition<A, B>: (a: A) => Future<Result<A, B>>

Precondition (async).

Type parameters

A
B

Type declaration

- (a: A): Future<Result<A, B>>
- Parameters
  - a: A
  Returns Future<Result<A, B>>

Variables

Const id

id: identity = identity

Functions

Const and

and<A, B, C>(l: Precondition<A, B>, r: Precondition<B, C>): Precondition<A, C>

- Defined in async/index.ts:50
and (async).

TODO: using the any type until Either is fixed in afpl.

Type parameters
- A
- B
- C
Parameters
- l: Precondition<A, B>
- r: Precondition<B, C>
Returns Precondition<A, C>

Const async

async<A, B>(p: sync.Precondition<A, B>): Precondition<A, B>

- Defined in async/index.ts:30
async wraps a sync api function so it can be used with other async functions.

Type parameters
- A
- B
Parameters
- p: sync.Precondition<A, B>
Returns Precondition<A, B>

Const caseOf

caseOf<A, B>(t: Pattern<A>, p: Precondition<A, B>): Precondition<A, B>

- Defined in async/index.ts:110
caseOf (async).

Type parameters
- A
- B
Parameters
- t: Pattern<A>
- p: Precondition<A, B>
Returns Precondition<A, B>

Const discard

discard<A>(_: A): Future<Either<Failure<A>, undefined>>

- Defined in async/index.ts:141
discard (async).

Type parameters
- A
Parameters
- _: A
Returns Future<Either<Failure<A>, undefined>>

Const every

every<A, B>(p: Precondition<A, B>, ...list: Precondition<B, B>[]): Precondition<A, B>

- Defined in async/index.ts:73
every (async).

Type parameters
- A
- B
Parameters
- p: Precondition<A, B>
- Rest ...list: Precondition<B, B>[]
Returns Precondition<A, B>

Const identity

identity<A>(value: A): Future<Either<Failure<A>, A>>

- Defined in async/index.ts:134
identity precondtion.

Succeeds with whatever value is passed.

Type parameters
- A
Parameters
- value: A
Returns Future<Either<Failure<A>, A>>

Const log

log<A>(value: A): Result<A, A>

- Defined in async/index.ts:152
log the value to the console.

Type parameters
- A
Parameters
- value: A
Returns Result<A, A>

Const match

match<A, B>(p: Precondition<A, B>, ...list: Precondition<A, B>[]): Precondition<A, B>

- Defined in async/index.ts:118
match (async version).

Type parameters
- A
- B
Parameters
- p: Precondition<A, B>
- Rest ...list: Precondition<A, B>[]
Returns Precondition<A, B>

Const optional

optional<A, B>(p: Precondition<A, A | B>): Precondition<A, A | B>

- Defined in async/index.ts:98
optional (async).

Type parameters
- A
- B
Parameters
- p: Precondition<A, A | B>
Returns Precondition<A, A | B>

Const or

or<A, B>(l: Precondition<A, B>, r: Precondition<A, B>): Precondition<A, B>

- Defined in async/index.ts:36
or (async).

Type parameters
- A
- B
Parameters
- l: Precondition<A, B>
- r: Precondition<A, B>
Returns Precondition<A, B>

Const reject

reject<A>(reason: string): Precondition<A, A>

- Defined in async/index.ts:146
reject always fails with reason no matter the value supplied.

Type parameters
- A
Parameters
- reason: string
Returns Precondition<A, A>

Generated using TypeDoc