Interface: IResult<T, E>

Type parameters

Name	Description
T	-
E	-

Methods

[iterator]

▸ [iterator](): Generator<T, any, unknown>

Returns

Generator<T, any, unknown>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:828

---

and

▸ and<U>(result): Result<U, E>

Type parameters

Name
U

Parameters

Name	Type	Description
result	Result<U, E>

Returns

Result<U, E>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:576

---

andThen

▸ andThen<U>(cb): Result<U, E>

Type parameters

Name
U

Parameters

Name	Type	Description
cb	(value: T) => Result<U, E>

Returns

Result<U, E>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:596

---

contains

▸ contains(value): boolean

Parameters

Name	Type	Description
value	T

Returns

boolean

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:674

---

containsErr

▸ containsErr(error): boolean

Parameters

Name	Type	Description
error	E

Returns

boolean

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:697

---

eq

▸ eq(other): boolean

Parameters

Name	Type	Description
other	Result<T, E>

Returns

boolean

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:770

---

err

▸ err(): Option<E>

Returns

Option<E>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:133

---

expect

▸ expect(message): T

Parameters

Name	Type	Description
message	string

Returns

T

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:401

---

expectErr

▸ expectErr(message): E

Parameters

Name	Type	Description
message	string

Returns

E

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:425

---

flatten

▸ flatten<IT>(this): Result<IT, E>

Type parameters

Name
IT

Parameters

Name	Type
this	Result<Result<IT, E>, E>

Returns

Result<IT, E>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:734

---

inspect

▸ inspect(cb): IResult<T, E>

Parameters

Name	Type	Description
cb	(value: T) => void

Returns

IResult<T, E>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:295

---

inspectAsync

▸ inspectAsync(cb): Promise<IResult<T, E>>

Parameters

Name	Type	Description
cb	(value: T) => Awaitable<void>

Returns

Promise<IResult<T, E>>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:314

---

inspectErr

▸ inspectErr(cb): IResult<T, E>

Parameters

Name	Type	Description
cb	(error: E) => void

Returns

IResult<T, E>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:333

---

inspectErrAsync

▸ inspectErrAsync(cb): Promise<IResult<T, E>>

Parameters

Name	Type	Description
cb	(error: E) => Awaitable<void>

Returns

Promise<IResult<T, E>>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:352

---

intoOkOrErr

▸ intoOkOrErr(): T | E

Returns

T | E

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:751

---

intoPromise

▸ intoPromise(): Promise<Result<Awaited<T>, Awaited<E>>>

Returns

Promise<Result<Awaited<T>, Awaited<E>>>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:763

---

isErr

▸ isErr(): this is Err<E>

Returns

this is Err<E>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:72

---

isErrAnd

▸ isErrAnd<R>(cb): this is Err<E> & R

Type parameters

Name	Type
R	extends boolean

Parameters

Name	Type	Description
cb	(error: E) => R

Returns

this is Err<E> & R

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:95

---

isOk

▸ isOk(): this is Ok<T>

Returns

this is Ok<T>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:33

---

isOkAnd

▸ isOkAnd<R>(cb): this is Ok<T> & R

Type parameters

Name	Type
R	extends boolean

Parameters

Name	Type
cb	(value: T) => R

Returns

this is Ok<T> & R

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:55

---

iter

▸ iter(): Generator<T, any, unknown>

Returns

Generator<T, any, unknown>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:377

---

map

▸ map<U>(cb): Result<U, E>

Type parameters

Name
U

Parameters

Name	Type	Description
cb	(value: T) => U

Returns

Result<U, E>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:152

---

mapErr

▸ mapErr<F>(cb): Result<T, F>

Type parameters

Name
F

Parameters

Name	Type	Description
cb	(error: E) => F

Returns

Result<T, F>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:247

---

mapErrInto

▸ mapErrInto<IT, IE>(cb): Result<T | IT, IE>

Type parameters

Name
IT
IE

Parameters

Name	Type	Description
cb	(error: E) => Result<IT, IE>

Returns

Result<T | IT, IE>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:276

---

mapInto

▸ mapInto<IT, IE>(cb): Result<IT, E | IE>

Type parameters

Name
IT
IE

Parameters

Name	Type	Description
cb	(value: T) => Result<IT, IE>

Returns

Result<IT, E | IE>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:182

---

mapOr

▸ mapOr<U>(defaultValue, cb): U

Type parameters

Name
U

Parameters

Name	Type	Description
defaultValue	U
cb	(value: T) => U

Returns

U

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:204

---

mapOrElse

▸ mapOrElse<U>(op, cb): U

Type parameters

Name
U

Parameters

Name	Type	Description
op	(error: E) => U
cb	(value: T) => U

Returns

U

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:226

---

match

▸ match<OkValue, ErrValue>(branches): OkValue | ErrValue

Type parameters

Name
OkValue
ErrValue

Parameters

Name	Type	Description
branches	Object
branches.err	(error: E) => ErrValue	-
branches.ok	(value: T) => OkValue	-

Returns

OkValue | ErrValue

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:799

---

ne

▸ ne(other): boolean

Parameters

Name	Type	Description
other	Result<T, E>

Returns

boolean

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:777

---

ok

▸ ok(): Option<T>

Returns

Option<T>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:114

---

or

▸ or<F>(result): Result<T, F>

Type parameters

Name
F

Parameters

Name	Type	Description
result	Result<T, F>

Returns

Result<T, F>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:631

---

orElse

▸ orElse<F>(cb): Result<T, F>

Type parameters

Name
F

Parameters

Name	Type	Description
cb	(error: E) => Result<T, F>

Returns

Result<T, F>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:651

---

transpose

▸ transpose<IT>(this): Option<Result<IT, E>>

Type parameters

Name
IT

Parameters

Name	Type
this	Result<Option<IT>, E>

Returns

Option<Result<IT, E>>

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:712

---

unwrap

▸ unwrap(): T

Returns

T

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:452

---

unwrapErr

▸ unwrapErr(): E

Returns

E

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:479

---

unwrapOr

▸ unwrapOr<V>(defaultValue): T | V

Type parameters

Name
V

Parameters

Name	Type	Description
defaultValue	V

Returns

T | V

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:505

---

unwrapOrElse

▸ unwrapOrElse<V>(op): T | V

Type parameters

Name
V

Parameters

Name	Type	Description
op	(error: E) => V

Returns

T | V

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:525

---

unwrapRaw

▸ unwrapRaw(): T

Returns

T

Defined in

node_modules/@sapphire/result/dist/lib/Result/IResult.d.ts:550