Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/monads/docs/README.md

👻 Option, Result, and Either types for TypeScript; Inspired by Rust
Go to Latest
File

@hqoss/monads

@hqoss/monads

Table of contents

Interfaces

Variables

Functions

Variables

None

• Const None: OptNone<any>

Defined in

option/option.ts:44

Functions

Err

â–¸ Err<T, E>(err): ResErr<T, E>

Type parameters

Name
T
E

Parameters

Name Type
err E

Returns

ResErr<T, E>

Defined in

result/result.ts:99


Left

â–¸ Left<L, R>(val): ResLeft<L, R>

Type parameters

Name
L
R

Parameters

Name Type
val L

Returns

ResLeft<L, R>

Defined in

either/either.ts:54


Ok

â–¸ Ok<T, E>(val): ResOk<T, E>

Type parameters

Name Type
T T
E never

Parameters

Name Type
val T

Returns

ResOk<T, E>

Defined in

result/result.ts:54


â–¸ Right<L, R>(val): ResRight<L, R>

Type parameters

Name
L
R

Parameters

Name Type
val R

Returns

ResRight<L, R>

Defined in

either/either.ts:111


Some

â–¸ Some<T>(val?): Option<T>

Type parameters

Name
T

Parameters

Name Type
val? T

Returns

Option<T>

Defined in

option/option.ts:38


isErr

â–¸ isErr<T, E>(val): val is ResErr

Type parameters

Name
T
E

Parameters

Name Type
val Result<T, E>

Returns

val is ResErr

Defined in

result/result.ts:148


isLeft

â–¸ isLeft<L, R>(val): val is ResLeft

Type parameters

Name
L
R

Parameters

Name Type
val Either<L, R>

Returns

val is ResLeft

Defined in

either/either.ts:168


isNone

â–¸ isNone<T>(val): val is OptNone

Type parameters

Name
T

Parameters

Name Type
val Option<T>

Returns

val is OptNone

Defined in

option/option.ts:132


isOk

â–¸ isOk<T, E>(val): val is ResOk

Type parameters

Name
T
E

Parameters

Name Type
val Result<T, E>

Returns

val is ResOk

Defined in

result/result.ts:144


isRight

â–¸ isRight<L, R>(val): val is ResRight

Type parameters

Name
L
R

Parameters

Name Type
val Either<L, R>

Returns

val is ResRight

Defined in

either/either.ts:172


isSome

â–¸ isSome<T>(val): val is OptSome

Type parameters

Name
T

Parameters

Name Type
val Option<T>

Returns

val is OptSome

Defined in

option/option.ts:128