Skip to content

Latest commit

 

History

History
364 lines (210 loc) · 6.35 KB

API.md

File metadata and controls

364 lines (210 loc) · 6.35 KB
Raw

typed-result

typed-result

Index

Classes

Type aliases

Functions

Type aliases

TErr

Ƭ TErr: object

Defined in index.ts:6

Type declaration:

  • error: E

  • kind: "Err"

TOk

Ƭ TOk: object

Defined in index.ts:1

Type declaration:

  • kind: "Ok"

  • value: T

TResult

Ƭ TResult: TOk‹T› | TErr‹E›

Defined in index.ts:11

Functions

Const drain

▸ drain‹T, E, TReturn›(iter: Iterator‹TResult‹T, E› | _‹T, E›, TReturn, T›): TResult‹TReturn, E›

Defined in index.ts:36

Type parameters:

▪ T

▪ E

▪ TReturn

Parameters:

Name Type
iter Iterator‹TResult‹T, E› | _‹T, E›, TReturn, T›

Returns: TResult‹TReturn, E›

Const drainAsync

▸ drainAsync‹T, E, TReturn›(iter: AsyncIterator‹TResult‹T, E› | _‹T, E›, TReturn, T›): Promise‹TResult‹TReturn, E››

Defined in index.ts:56

Type parameters:

▪ T

▪ E

▪ TReturn

Parameters:

Name Type
iter AsyncIterator‹TResult‹T, E› | _‹T, E›, TReturn, T›

Returns: Promise‹TResult‹TReturn, E››

Const err

▸ err‹E›(error: E): TErr‹E›

Defined in index.ts:18

Type parameters:

▪ E

Parameters:

Name Type
error E

Returns: TErr‹E›

Const isErr

▸ isErr‹T, E›(result: TResult‹T, E›): result is TErr

Defined in index.ts:26

Type parameters:

▪ T

▪ E

Parameters:

Name Type
result TResult‹T, E›

Returns: result is TErr

Const isOk

▸ isOk‹T, E›(result: TResult‹T, E›): result is TOk

Defined in index.ts:23

Type parameters:

▪ T

▪ E

Parameters:

Name Type
result TResult‹T, E›

Returns: result is TOk

Const ok

▸ ok‹T›(value: T): TOk‹T›

Defined in index.ts:13

Type parameters:

▪ T

Parameters:

Name Type
value T

Returns: TOk‹T›

Const unwrap

▸ unwrap‹T, E›(result: TResult‹T, E›): T | never

Defined in index.ts:29

Type parameters:

▪ T

▪ E

Parameters:

Name Type
result TResult‹T, E›

Returns: T | never

Const unwrapFn

▸ unwrapFn‹T, E, X1, X2, X3, X4›(fn: function): function

Defined in index.ts:113

Type parameters:

▪ T

▪ E

▪ X1

▪ X2

▪ X3

▪ X4

Parameters:

▪ fn: function

▸ (x1: X1, x2: X2, x3: X3, x4: X4): TResult‹T, E›

Parameters:

Name Type
x1 X1
x2 X2
x3 X3
x4 X4

Returns: function

▸ (x1: X1, x2: X2, x3: X3, x4: X4): T | never

Parameters:

Name Type
x1 X1
x2 X2
x3 X3
x4 X4

Const wrapAsyncFn

▸ wrapAsyncFn‹T, X1, X2, X3, X4›(fn: function): function

Defined in index.ts:98

Type parameters:

▪ T

▪ X1

▪ X2

▪ X3

▪ X4

Parameters:

▪ fn: function

▸ (x1: X1, x2: X2, x3: X3, x4: X4): Promise‹T›

Parameters:

Name Type
x1 X1
x2 X2
x3 X3
x4 X4

Returns: function

▸ (x1: X1, x2: X2, x3: X3, x4: X4): Promise‹TResult‹T, unknown››

Parameters:

Name Type
x1 X1
x2 X2
x3 X3
x4 X4

Const wrapFn

▸ wrapFn‹T, X1, X2, X3, X4›(fn: function): function

Defined in index.ts:76

Type parameters:

▪ T

▪ X1

▪ X2

▪ X3

▪ X4

Parameters:

▪ fn: function

▸ (x1: X1, x2: X2, x3: X3, x4: X4): T

Parameters:

Name Type
x1 X1
x2 X2
x3 X3
x4 X4

Returns: function

▸ (x1: X1, x2: X2, x3: X3, x4: X4): TResult‹T, unknown›

Parameters:

Name Type
x1 X1
x2 X2
x3 X3
x4 X4