maybe.md

Package / Modules / maybe

Module: maybe

Table of contents

References

• from
• fromEitherLeft
• fromEitherRight

Modules

• <internal>

Enumerations

• MaybeState

Interfaces

• MaybeOperation

Type Aliases

• Maybe
• SerializedMaybe

Functions

• asyncIterator
• chain
• filterMap
• fromJSON
• fromNullable
• isJust
• isMaybe
• isNone
• iterator
• just
• merge
• none

References

from

Renames and re-exports __type

---

fromEitherLeft

Renames and re-exports __type

---

fromEitherRight

Renames and re-exports __type

Type Aliases

Maybe

Ƭ Maybe<T>: Just<T> | None<T>

Type parameters

Name
T

Defined in

dist/maybe.d.ts:70

---

SerializedMaybe

Ƭ SerializedMaybe<T>: SerializedJust<T> | SerializedNone

Type parameters

Name
T

Defined in

dist/maybe.d.ts:71

Functions

asyncIterator

▸ asyncIterator<T>(callback): AsyncGenerator<T, void, void>

Type parameters

Name
T

Parameters

Name	Type
callback	() => MaybePromiseLike<Maybe<MaybePromiseLike<T>>>

Returns

AsyncGenerator<T, void, void>

Defined in

dist/maybe.d.ts:86

---

chain

▸ chain<A, B, P>(map, ...parameters): (maybe: Maybe<A>) => Promise<Maybe<B>>

Type parameters

Name	Type
A	A
B	B
P	extends AnyParameters

Parameters

Name	Type
map	(v: A, ...parameters: P) => MaybePromiseLike<Maybe<B>>
...parameters	P

Returns

fn

▸ (maybe): Promise<Maybe<B>>

Parameters

Name	Type
maybe	Maybe<A>

Returns

Promise<Maybe<B>>

Defined in

dist/maybe.d.ts:75

---

filterMap

▸ filterMap<A, B>(iterable, filterMap): Generator<B, void, void>

Type parameters

Name
A
B

Parameters

Name	Type
iterable	Iterable<A>
filterMap	(value: A, index: number) => Maybe<B>

Returns

Generator<B, void, void>

Defined in

dist/maybe.d.ts:87

---

fromJSON

▸ fromJSON<T>(serialized): Maybe<T>

Type parameters

Name
T

Parameters

Name	Type
serialized	SerializedMaybe<T>

Returns

Maybe<T>

Defined in

dist/maybe.d.ts:76

---

fromNullable

▸ fromNullable<T>(value): Maybe<T>

Type parameters

Name
T

Parameters

Name	Type
value	Nullable<T>

Returns

Maybe<T>

Defined in

dist/maybe.d.ts:84

---

isJust

▸ isJust<T>(value): value is Just<T>

Type parameters

Name
T

Parameters

Name	Type
value	unknown

Returns

value is Just<T>

Defined in

dist/maybe.d.ts:72

---

isMaybe

▸ isMaybe<T>(value): value is Maybe<T>

Type parameters

Name
T

Parameters

Name	Type
value	unknown

Returns

value is Maybe<T>

Defined in

dist/maybe.d.ts:74

---

isNone

▸ isNone<T>(value): value is None<T>

Type parameters

Name
T

Parameters

Name	Type
value	unknown

Returns

value is None<T>

Defined in

dist/maybe.d.ts:73

---

iterator

▸ iterator<T>(callback): Generator<T, void, void>

Type parameters

Name
T

Parameters

Name	Type
callback	() => Maybe<T>

Returns

Generator<T, void, void>

Defined in

dist/maybe.d.ts:85

---

just

▸ just<T>(value): Maybe<T>

Type parameters

Name
T

Parameters

Name	Type
value	T

Returns

Maybe<T>

Defined in

dist/maybe.d.ts:8

---

merge

▸ merge<V1>(values): Maybe<[V1]>

Type parameters

Name
V1

Parameters

Name	Type
values	[Maybe<V1>]

Returns

Maybe<[V1]>

Defined in

dist/maybe.d.ts:77

▸ merge<V1, V2>(values): Maybe<[V1, V2]>

Type parameters

Name
V1
V2

Parameters

Name	Type
values	[Maybe<V1>, Maybe<V2>]

Returns

Maybe<[V1, V2]>

Defined in

dist/maybe.d.ts:78

▸ merge<V1, V2, V3>(values): Maybe<[V1, V2, V3]>

Type parameters

Name
V1
V2
V3

Parameters

Name	Type
values	[Maybe<V1>, Maybe<V2>, Maybe<V3>]

Returns

Maybe<[V1, V2, V3]>

Defined in

dist/maybe.d.ts:79

▸ merge<V1, V2, V3, V4>(values): Maybe<[V1, V2, V3, V4]>

Type parameters

Name
V1
V2
V3
V4

Parameters

Name	Type
values	[Maybe<V1>, Maybe<V2>, Maybe<V3>, Maybe<V4>]

Returns

Maybe<[V1, V2, V3, V4]>

Defined in

dist/maybe.d.ts:80

▸ merge<V1, V2, V3, V4, V5>(values): Maybe<[V1, V2, V3, V4, V5]>

Type parameters

Name
V1
V2
V3
V4
V5

Parameters

Name	Type
values	[Maybe<V1>, Maybe<V2>, Maybe<V3>, Maybe<V4>, Maybe<V5>]

Returns

Maybe<[V1, V2, V3, V4, V5]>

Defined in

dist/maybe.d.ts:81

▸ merge<V1, V2, V3, V4, V5, V6>(values): Maybe<[V1, V2, V3, V4, V5, V6]>

Type parameters

Name
V1
V2
V3
V4
V5
V6

Parameters

Name	Type
values	[Maybe<V1>, Maybe<V2>, Maybe<V3>, Maybe<V4>, Maybe<V5>, Maybe<V6>]

Returns

Maybe<[V1, V2, V3, V4, V5, V6]>

Defined in

dist/maybe.d.ts:82

▸ merge<T>(values): Maybe<T[]>

Type parameters

Name
T

Parameters

Name	Type
values	Maybe<T>[]

Returns

Maybe<T[]>

Defined in

dist/maybe.d.ts:83

---

none

▸ none<T>(): Maybe<T>

Type parameters

Name	Type
T	never

Returns

Maybe<T>

Defined in

dist/maybe.d.ts:7