Class IOk<OkType>

Result Ok instance.

Note: this class should not be used directly, use Ok function instead

Since

v1.0.0

Type Parameters

OkType
Ok type

Implements

IResultBuild<true, OkType, never>

Index

Constructors

constructor

new IOk<OkType>(value: OkType | IJsonOk<OkType>): IOk<OkType>
Type Parameters
- OkType
Parameters
- value: OkType | IJsonOk<OkType>
Returns IOk<OkType>
- Defined in src/result/OkInstance.mts:14

Accessors

isErr

get isErr(): false
Check that result is an error

Returns false
true if result is an error
Example
```
Ok<number>(2).isErr // false
Err<Error>(new Error('broken')).isErr // true
```
Implementation of IResultBuild.isErr
- Defined in src/result/OkInstance.mts:34

isOk

get isOk(): true
Check that result is not an error

Returns true
true if result is not an error
Example
```
Ok<number>(2).isOk // true
Err<Error>(new Error('broken')).isOk // false
```
Implementation of IResultBuild.isOk
- Defined in src/result/OkInstance.mts:18

Methods

and

and<CompareType>(value: IResult<CompareType>): IResult<CompareType>
Method to combine two results, if the first result is true return the second result, otherwise return the first result
Type Parameters
- CompareType
Parameters
- value: IResult<CompareType>
  compare value
Returns IResult<CompareType>
- Result based on the self value and the value parameter
Example
```
Err<Error>(new Error('broken')).and(Ok<number>(3)) // Err<Error>(new Error('broken'))
Ok<number>(2).and(Err<number>(new Error('broken'))) // Err<Error>(new Error('broken'))
Ok<number>(2).and(Ok<number>(3)) // Ok<number>(3)
```
Implementation of IResultBuild.and
- Defined in src/result/OkInstance.mts:86

andThen

andThen<OutResult extends IResult<unknown, unknown>>(
callbackFunc: (val: OkType) => OutResult,
): OutResult
Method to combine two results, if the first result is true use the value to build a new result, otherwise return the error
Type Parameters
- OutResult extends IResult<unknown, unknown>
Parameters
- callbackFunc: (val: OkType) => OutResult
  callback to build a new result
Returns OutResult
- Result based on the self value and the value parameter
Example
```
Ok<number>(2).andThen<IResult<number>>((val) => Ok(val + 1)) // Ok<number>(3)
Err<'broken'>('broken').andThen<IResult<number>>((val) => Ok(val + 1)) // Err<'broken'>('broken')
```
Implementation of IResultBuild.andThen
- Defined in src/result/OkInstance.mts:94

andThenPromise

andThenPromise<OutResult extends IResult<unknown, unknown>>(
callbackFunc: (val: OkType) => Promise<OutResult>,
): Promise<OutResult>
Method to combine two results, if the first result is true use the value to build a new result from Promise, otherwise return the error
Type Parameters
- OutResult extends IResult<unknown, unknown>
Parameters
- callbackFunc: (val: OkType) => Promise<OutResult>
  callback to build a new result
Returns Promise<OutResult>
- Result based on the self value and the value parameter
Example
```
await Ok<number>(2).andThen<IResult<number>>((val) => Promise.resolve(Ok(val + 1))) // Ok<number>(3)
await Err<'broken'>('broken').andThen<IResult<number>>((val) => Promise.resolve(Ok(val + 1))) // Err<'broken'>('broken')
```
Implementation of IResultBuild.andThenPromise
- Defined in src/result/OkInstance.mts:98

clone

clone(): IOk<OkType>
Method to clone an result

Returns IOk<OkType>
- cloned result instance
Example
```
const x = Ok(2);
const y = x.clone(); // Ok(2)
```
Implementation of IResultBuild.clone
- Defined in src/result/OkInstance.mts:90

eq

eq(other: IResult): boolean
Method to compare two results
Parameters
- other: IResult
  other result to compare
Returns boolean
true if results are equal
Example
```
Ok<number>(2).eq(Ok<number>(2)) // true
Ok<number>(2).eq(Ok<number>(3)) // false
Err<number>(2).eq(Err<number>(2)) // true
```
Implementation of IResultBuild.eq
- Defined in src/result/OkInstance.mts:70

err

err(): undefined
Try to get the error, otherwise return undefined

Returns undefined
error or undefined
Example
```
Ok<number>(2).err() // undefined
Err<Error>(new Error('broken')).err() // Error('broken')
```
Implementation of IResultBuild.err
- Defined in src/result/OkInstance.mts:38

inspect

inspect(fn: (value: OkType) => void): this
Inspect the result value if Ok
Parameters
- fn: (value: OkType) => void
  function to inspect the value
Returns this
this result instance
Example
```
Ok<number>(2).inspect((value) => console.log('Value:', value)).unwrap() // logs 'Value: 2' and returns 2
```
Since
v1.0.8
Implementation of IResultBuild.inspect
- Defined in src/result/OkInstance.mts:102

inspectErr

inspectErr(_fn: (value: never) => void): this
Inspect the result value if Err
Parameters
- _fn: (value: never) => void
Returns this
this result instance
Example
```
Err<Error>(new Error('broken')).inspectErr((err) => console.error('Error:', err)).unwrap() // logs 'Error: Error('broken')' and throws
```
Since
v1.0.8
Implementation of IResultBuild.inspectErr
- Defined in src/result/OkInstance.mts:112

isErrAnd

isErrAnd(_callbackFunc: (value: never) => boolean): false
Returns true if the result is Err and callback function returns true for the value inside of Err.
Parameters
- _callbackFunc: (value: never) => boolean
Returns false
true if the result is Err and the callback function returns true for the value inside of Err
Example
```
Err<Error>(new Error('broken')).isErrAnd((err) => err.message === 'broken') // true
Err<Error>(new Error('broken')).isErrAnd((err) => err.message === 'not broken') // false
Ok<number>(2).isErrAnd((err) => err.message === 'broken') // false
```
Since
v1.0.8
Implementation of IResultBuild.isErrAnd
- Defined in src/result/OkInstance.mts:26

isOkAnd

isOkAnd(callbackFunc: (value: OkType) => boolean): boolean
Returns true if the result is Ok and callback function returns true for the value inside of Ok.
Parameters
- callbackFunc: (value: OkType) => boolean
  function to check the value inside of Ok
Returns boolean
true if the result is Ok and the callback function returns true for the value inside of Ok
Example
```
Ok<number>(2).isOkAnd((value) => value === 2) // true
Ok<number>(2).isOkAnd((value) => value === 3) // false
Err<Error>(new Error('broken')).isOkAnd((value) => value === 2) // false
```
Since
v1.0.8
Implementation of IResultBuild.isOkAnd
- Defined in src/result/OkInstance.mts:22

iter

iter(): IterableIterator<IOk<OkType>>
Iterate over the result value

Returns IterableIterator<IOk<OkType>>
iterable iterator of the result value
Example
```
Ok<number>(2).iter().next().value; // Ok<number>(2)
Err<Error>(new Error('broken')).iter().next().done; // true (no values to iterate)
```
Since
v1.0.9
Implementation of IResultBuild.iter
- Defined in src/result/OkInstance.mts:116

map

map<NewOkType>(callbackFunc: (val: OkType) => NewOkType): IOk<NewOkType>
Map the result value to a new value if Ok
Type Parameters
- NewOkType
Parameters
- callbackFunc: (val: OkType) => NewOkType
Returns IOk<NewOkType>
Example
```
Ok<string, Error>('hello').map((v)=> Buffer.from(v)) // Ok<Buffer, Error>
Err<Error, string>(new Error('broken')).map((v)=> Buffer.from(v)) // Err<Error, Buffer>
```
Since
v1.0.4
Implementation of IResultBuild.map
- Defined in src/result/OkInstance.mts:42

mapErr

mapErr<NewErrType>(_callbackFunc: (val: never) => NewErrType): this

Map the error value to a new value if Err

Type Parameters

NewErrType

Parameters

_callbackFunc: (val: never) => NewErrType

Returns this

new error result instance with mapped error

Example

const mapAsTypeErr = (err: Error): TypeError => new TypeError(`Mapped: ${err.message}`);
Err<Error>(new Error('broken')).mapErr(mapAsTypeErr) // Err<TypeError>(new TypeError('Mapped: broken'))
Ok<number>(2).mapErr(mapAsTypeErr); // Ok<number>(2)
// error mapping and logging example
const logErr = (err: Error) => console.error('Error:', err);
Err<Error>(new Error('broken')).mapErr(mapAsTypeErr).inspectErr(logErr);

Since

v1.0.4

ok

ok(): OkType
Try to get value, otherwise return undefined

Returns OkType
value or undefined
Example
```
Ok<number>(2).ok() // 2
Err<Error>(new Error('broken')).ok() // undefined
```
Implementation of IResultBuild.ok
- Defined in src/result/OkInstance.mts:30

or

or<CompareType>(_value: IResult<CompareType>): this
Method to combine two results, if the first result is false return the second result, otherwise return the first result
Type Parameters
- CompareType
Parameters
- _value: IResult<CompareType>
Returns this
- Result based on the self value and the value parameter
Example
```
Err<Error>(new Error('broken')).or(Ok<number>(3)) // Ok<number>(3)
Ok<number>(2).or(Err<Error>(new Error('broken'))) // Ok<number>(2)
Ok<number>(2).or(Ok<number>(3)) // Ok<number>(2)
```
Implementation of IResultBuild.or
- Defined in src/result/OkInstance.mts:74

orElse

orElse<OutResult extends IResult<unknown, unknown>>(
_callbackFunc: (value: never) => OutResult,
): this
Method to combine two results, if the first result is false use the error to build a new result, otherwise return the first result
Type Parameters
- OutResult extends IResult<unknown, unknown>
Parameters
- _callbackFunc: (value: never) => OutResult
Returns this
- Result based on the self value and the value parameter
Example
```
Ok<number>(2).orElse<IResult<number>>((errValue) => Ok(errValue * 2)) // Ok<number>(2)
Err<number>(2).orElse<IResult<number>>((errValue) => Ok(errValue * 2)) // Ok<number>(4)
```
Implementation of IResultBuild.orElse
- Defined in src/result/OkInstance.mts:78

orElsePromise

orElsePromise<OutResult extends IResult<unknown, unknown>>(
_callbackFunc: (value: never) => Promise<OutResult>,
): this
Method to combine two results, if the first result is false use the error to build a new result from Promise, otherwise return the first result
Type Parameters
- OutResult extends IResult<unknown, unknown>
Parameters
- _callbackFunc: (value: never) => Promise<OutResult>
Returns this
- Result based on the self value and the value parameter
Example
```
await Ok<number>(2).orElsePromise<IResult<number>>((errValue) => Promise.resolve(Ok(errValue * 2))) // Ok<number>(2)
await Err<number>(2).orElsePromise<IResult<number>>((errValue) => Promise.resolve(Ok(errValue * 2))) // Ok<number>(4)
```
Implementation of IResultBuild.orElsePromise
- Defined in src/result/OkInstance.mts:82

toJSON

toJSON(): IJsonOk<OkType>
Convert result to JSON {$class: 'Result::Ok', value: OkType} or {$class: 'Result::Err', value: ErrType}

Returns IJsonOk<OkType>
JSON representation of the result
Example
```
Ok<number>(2).toJSON() // {$class: 'Result::Ok', value: 2}
Err<number>(2).toJSON() // {$class: 'Result::Err', value: 2}
```
Implementation of IResultBuild.toJSON
- Defined in src/result/OkInstance.mts:128

toOption

toOption(): ISome<OkType>
Convert result to option and discard the error type

Returns ISome<OkType>
option
Example
```
Ok<number>(2).toOption() // Some<number>(2)
Err<number>(2).toOption() // None<never>()
```
Implementation of IResultBuild.toOption
- Defined in src/result/OkInstance.mts:50

toString

toString(): `Ok(${string})`
Convert result to string

Returns `Ok(${string})`
string representation of the result
Example
```
Ok<number>(2).toString() // 'Ok(2)'
Err<number>(2).toString() // 'Err(2)'
```
Implementation of IResultBuild.toString
- Defined in src/result/OkInstance.mts:124

unwrap

unwrap(): OkType
Method to unwrap the value or throw an error.

Note: Error argument/callback was removed in favor of the .errMap((e) => new Error(e.message)).unwrap() method.

Returns OkType
Example
```
Ok<number>(2).unwrap() // 2
Err<Error>(new Error('broken')).unwrap() // throws Error('broken')
```
Implementation of IResultBuild.unwrap
- Defined in src/result/OkInstance.mts:54

unwrapOr

unwrapOr<DefaultType>(_defaultValue: DefaultType): OkType
Method to unwrap the value or if error return the default value
Type Parameters
- DefaultType
Parameters
- _defaultValue: DefaultType
Returns OkType
Example
```
Ok<number>(2).unwrapOr(0) // 2
Err<number>(new Error('broken')).unwrapOr(0) // 0
```
Implementation of IResultBuild.unwrapOr
- Defined in src/result/OkInstance.mts:58

unwrapOrElse

unwrapOrElse<DefaultType>(_callbackFunc: () => DefaultType): OkType
Method to unwrap the value or if error return default value from function
Type Parameters
- DefaultType
Parameters
- _callbackFunc: () => DefaultType
Returns OkType
Example
```
Ok<number>(2).unwrapOrElse(() => 0) // 2
Err<number>(new Error('broken')).unwrapOrElse(() => 0) // 0
```
Implementation of IResultBuild.unwrapOrElse
- Defined in src/result/OkInstance.mts:62

unwrapOrValueOf

unwrapOrValueOf<ValueType>(
_constructorValueOf: ConstructorWithValueOf<ValueType>,
): OkType
Method to unwrap the value or if error return default value from constructors valueOf
Type Parameters
- ValueType
Parameters
- _constructorValueOf: ConstructorWithValueOf<ValueType>
Returns OkType
Example
```
Ok<number>(2).unwrapOrValueOf(Number) // 2
Err<Error>(new Error('broken')).unwrapOrValueOf(Number) // 0 (Number.valueOf())
```
Implementation of IResultBuild.unwrapOrValueOf
- Defined in src/result/OkInstance.mts:66

Class IOk<OkType>

Since

Type Parameters

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns IOk<OkType>

Accessors

isErr

Returns false

Example

isOk

Returns true

Example

Methods

and

Type Parameters

Parameters

Returns IResult<CompareType>

Example

andThen

Type Parameters

Parameters

Returns OutResult

Example

andThenPromise

Type Parameters

Parameters

Returns Promise<OutResult>

Example

clone

Returns IOk<OkType>

Example

eq

Parameters

Returns boolean

Example

err

Returns undefined

Example

inspect

Parameters

Returns this

Example

Since

inspectErr

Parameters

Returns this

Example

Since

isErrAnd

Parameters

Returns false

Example

Since

isOkAnd

Parameters

Returns boolean

Example

Since

iter

Returns IterableIterator<IOk<OkType>>

Example

Since

map

Type Parameters

Parameters

Returns IOk<NewOkType>

Example

Since

mapErr

Type Parameters

Parameters

Returns this