maybe._internal_.Just.md

Package / Modules / maybe / <internal> / Just

Class: Just<T>

maybe.<internal>.Just

Type parameters

Name
T

Hierarchy

• MaybeConstructor<T>

  ↳ Just

Implements

• SerializedJust<T>

Table of contents

Constructors

• constructor

Properties

• value

Accessors

• [toStringTag]
• name
• type

Methods

• apply
• asyncApply
• asyncChain
• asyncMap
• await
• chain
• default
• filter
• flatMap
• fold
• isJust
• isNone
• join
• map
• mapNullable
• or
• orAsync
• orLazy
• pipe
• tap
• toJSON
• unwrap
• unwrapOr
• unwrapOrElse
• zip
• create

Constructors

constructor

• Private new Just<T>()

Type parameters

Name
T

Overrides

MaybeConstructor.constructor

Defined in

dist/maybe.d.ts:53

Properties

value

• Readonly value: T

Implementation of

SerializedJust.value

Defined in

dist/maybe.d.ts:48

Accessors

[toStringTag]

• get [toStringTag](): Just

Returns

Just

Defined in

dist/maybe.d.ts:50

---

name

• get name(): "Maybe"

Returns

"Maybe"

Implementation of

SerializedJust.name

Defined in

dist/maybe.d.ts:51

---

type

• get type(): Just

Returns

Just

Implementation of

SerializedJust.type

Defined in

dist/maybe.d.ts:52

Methods

apply

▸ apply<A, B, P>(this, argument, ...parameters): Maybe<B>

Type parameters

Name	Type
A	A
B	B
P	extends AnyParameters

Parameters

Name	Type
this	Maybe<Mapper<A, B, P>>
argument	Maybe<A>
...parameters	P

Returns

Maybe<B>

Inherited from

MaybeConstructor.apply

Defined in

dist/maybe.d.ts:22

▸ apply<A, B, P>(this, argument, ...parameters): Maybe<B>

Type parameters

Name	Type
A	A
B	B
P	extends AnyParameters

Parameters

Name	Type
this	Maybe<A>
argument	Maybe<Mapper<A, B, P>>
...parameters	P

Returns

Maybe<B>

Inherited from

MaybeConstructor.apply

Defined in

dist/maybe.d.ts:23

---

asyncApply

▸ asyncApply<A, B, P>(this, argument, ...parameters): Promise<Maybe<B>>

Type parameters

Name	Type
A	A
B	B
P	extends AnyParameters

Parameters

Name	Type
this	Maybe<Mapper<A, MaybePromiseLike<B>, P>>
argument	Maybe<A>
...parameters	P

Returns

Promise<Maybe<B>>

Inherited from

MaybeConstructor.asyncApply

Defined in

dist/maybe.d.ts:39

▸ asyncApply<A, B, P>(this, map, ...parameters): Promise<Maybe<B>>

Type parameters

Name	Type
A	A
B	B
P	extends AnyParameters

Parameters

Name	Type
this	Maybe<A>
map	Maybe<Mapper<A, MaybePromiseLike<B>, P>>
...parameters	P

Returns

Promise<Maybe<B>>

Inherited from

MaybeConstructor.asyncApply

Defined in

dist/maybe.d.ts:40

---

asyncChain

▸ asyncChain<T, P>(map, ...parameters): Promise<Maybe<T>>

Type parameters

Name	Type
T	T
P	extends AnyParameters

Parameters

Name	Type
map	Mapper<T, MaybePromiseLike<Maybe<T>>, P>
...parameters	P

Returns

Promise<Maybe<T>>

Inherited from

MaybeConstructor.asyncChain

Defined in

dist/maybe.d.ts:36

---

asyncMap

▸ asyncMap<T, P>(map, ...parameters): Promise<Maybe<T>>

Type parameters

Name	Type
T	T
P	extends AnyParameters

Parameters

Name	Type
map	Mapper<T, MaybePromiseLike<T>, P>
...parameters	P

Returns

Promise<Maybe<T>>

Inherited from

MaybeConstructor.asyncMap

Defined in

dist/maybe.d.ts:37

---

await

▸ await<T>(this): Promise<Maybe<T>>

Type parameters

Name
T

Parameters

Name	Type
this	Maybe<MaybePromiseLike<T>>

Returns

Promise<Maybe<T>>

Inherited from

MaybeConstructor.await

Defined in

dist/maybe.d.ts:38

---

chain

▸ chain<V, P>(map, ...parameters): Maybe<V>

Type parameters

Name	Type
V	V
P	extends AnyParameters

Parameters

Name	Type
map	Mapper<T, Maybe<V>, P>
...parameters	P

Returns

Maybe<V>

Inherited from

MaybeConstructor.chain

Defined in

dist/maybe.d.ts:26

---

default

▸ default(value): Maybe<T>

Parameters

Name	Type
value	T

Returns

Maybe<T>

Inherited from

MaybeConstructor.default

Defined in

dist/maybe.d.ts:27

---

filter

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

Type parameters

Name
T

Parameters

Name	Type
filter	(input: T) => input is T

Returns

Maybe<T>

Inherited from

MaybeConstructor.filter

Defined in

dist/maybe.d.ts:24

▸ filter(filter): Maybe<T>

Parameters

Name	Type
filter	(input: T) => boolean

Returns

Maybe<T>

Inherited from

MaybeConstructor.filter

Defined in

dist/maybe.d.ts:25

---

flatMap

▸ flatMap<T, P>(map, ...parameters): undefined | T

Type parameters

Name	Type
T	T
P	extends AnyParameters

Parameters

Name	Type
map	Mapper<T, T, P>
...parameters	P

Returns

undefined | T

Inherited from

MaybeConstructor.flatMap

Defined in

dist/maybe.d.ts:33

---

fold

▸ fold<A, B>(mapNone, mapJust): A | B

Type parameters

Name	Type
A	A
B	A

Parameters

Name	Type
mapNone	Mapper<void, B>
mapJust	Mapper<T, A>

Returns

A | B

Inherited from

MaybeConstructor.fold

Defined in

dist/maybe.d.ts:35

---

isJust

▸ isJust(): this is Just<T>

Returns

this is Just<T>

Inherited from

MaybeConstructor.isJust

Defined in

dist/maybe.d.ts:16

---

isNone

▸ isNone(): this is None<T>

Returns

this is None<T>

Inherited from

MaybeConstructor.isNone

Defined in

dist/maybe.d.ts:17

---

join

▸ join<V>(this): Maybe<V>

Type parameters

Name
V

Parameters

Name	Type
this	Maybe<Maybe<V>>

Returns

Maybe<V>

Inherited from

MaybeConstructor.join

Defined in

dist/maybe.d.ts:18

---

map

▸ map<V, P>(map, ...parameters): Maybe<V>

Type parameters

Name	Type
V	V
P	extends AnyParameters

Parameters

Name	Type
map	Mapper<T, V, P>
...parameters	P

Returns

Maybe<V>

Inherited from

MaybeConstructor.map

Defined in

dist/maybe.d.ts:20

---

mapNullable

▸ mapNullable<V, P>(map, ...parameters): Maybe<V>

Type parameters

Name	Type
V	V
P	extends AnyParameters

Parameters

Name	Type
map	Mapper<T, undefined | null | V, P>
...parameters	P

Returns

Maybe<V>

Inherited from

MaybeConstructor.mapNullable

Defined in

dist/maybe.d.ts:21

---

or

▸ or(x): Maybe<T>

Parameters

Name	Type
x	Maybe<T>

Returns

Maybe<T>

Inherited from

MaybeConstructor.or

Defined in

dist/maybe.d.ts:28

---

orAsync

▸ orAsync(factory): Promise<Maybe<T>>

Parameters

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

Returns

Promise<Maybe<T>>

Inherited from

MaybeConstructor.orAsync

Defined in

dist/maybe.d.ts:30

---

orLazy

▸ orLazy(factory): Maybe<T>

Parameters

Name	Type
factory	() => Maybe<T>

Returns

Maybe<T>

Inherited from

MaybeConstructor.orLazy

Defined in

dist/maybe.d.ts:29

---

pipe

▸ pipe<V, P>(pipe, ...parameters): V

Type parameters

Name	Type
V	V
P	extends AnyParameters

Parameters

Name	Type
pipe	Mapper<Maybe<T>, V, P>
...parameters	P

Returns

V

Inherited from

MaybeConstructor.pipe

Defined in

dist/maybe.d.ts:19

---

tap

▸ tap<P>(callback, ...parameters): Maybe<T>

Type parameters

Name	Type
P	extends AnyParameters

Parameters

Name	Type
callback	Mapper<T, void, P>
...parameters	P

Returns

Maybe<T>

Inherited from

MaybeConstructor.tap

Defined in

dist/maybe.d.ts:32

---

toJSON

▸ toJSON(): Readonly<{ name: "Maybe" ; type: Just ; value: T }>

Returns

Readonly<{ name: "Maybe" ; type: Just ; value: T }>

Defined in

dist/maybe.d.ts:54

---

unwrap

▸ unwrap(message?): T

Parameters

Name	Type
message?	string

Returns

T

Inherited from

MaybeConstructor.unwrap

Defined in

dist/maybe.d.ts:34

---

unwrapOr

▸ unwrapOr<T>(value): T | T

Type parameters

Name
T

Parameters

Name	Type
value	T

Returns

T | T

Inherited from

MaybeConstructor.unwrapOr

Defined in

dist/maybe.d.ts:14

---

unwrapOrElse

▸ unwrapOrElse<T>(value): T | T

Type parameters

Name
T

Parameters

Name	Type
value	() => T

Returns

T | T

Inherited from

MaybeConstructor.unwrapOrElse

Defined in

dist/maybe.d.ts:15

---

zip

▸ zip<T>(maybe): Maybe<Pair<T, T>>

Type parameters

Name
T

Parameters

Name	Type
maybe	Maybe<T>

Returns

Maybe<Pair<T, T>>

Inherited from

MaybeConstructor.zip

Defined in

dist/maybe.d.ts:31

---

create

▸ Static create<T>(value): Just<T>

Type parameters

Name
T

Parameters

Name	Type
value	T

Returns

Just<T>

Defined in

dist/maybe.d.ts:49