Function safeTry

safeTry<T, E>(body: (() => Generator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>)): neverthrow.Result<T, E>
Evaluates the given generator to a Result returned or an Err yielded from it, whichever comes first.

This function, in combination with Result.safeUnwrap(), is intended to emulate Rust's ? operator. See /tests/safeTry.test.ts for examples.
Type Parameters
- T
- E
Parameters
- body: (() => Generator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>)
  What is evaluated. In body, yield* result.safeUnwrap() works as Rust's result? expression.
  - - (): Generator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>
    - Returns Generator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>
Returns neverthrow.Result<T, E>
The first occurence of either an yielded Err or a returned Result.
- Defined in node_modules/neverthrow/dist/index.d.ts:89
safeTry<T, E>(body: (() => AsyncGenerator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>)): Promise<neverthrow.Result<T, E>>
Evaluates the given generator to a Result returned or an Err yielded from it, whichever comes first.

This function, in combination with Result.safeUnwrap(), is intended to emulate Rust's ? operator. See /tests/safeTry.test.ts for examples.
Type Parameters
- T
- E
Parameters
- body: (() => AsyncGenerator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>)
  What is evaluated. In body, yield* result.safeUnwrap() and yield* resultAsync.safeUnwrap() work as Rust's result? expression.
  - - (): AsyncGenerator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>
    - Returns AsyncGenerator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>
Returns Promise<neverthrow.Result<T, E>>
The first occurence of either an yielded Err or a returned Result.
- Defined in node_modules/neverthrow/dist/index.d.ts:102

Function safeTry

Type Parameters

Parameters

Returns Generator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>

Returns neverthrow.Result<T, E>

Type Parameters

Parameters

Returns AsyncGenerator<neverthrow.Err<never, E>, neverthrow.Result<T, E>, unknown>

Returns Promise<neverthrow.Result<T, E>>

Settings

Member Visibility

Theme