ts-data-forge
    Preparing search index...

    Function unwrapOk

    • Safely unwraps the success value, returning undefined for failures.

      Type Parameters

      • R extends Readonly<{}>

      Parameters

      • result: R

      Returns UnwrapOk<R>

      const okResult = Result.ok(42);

      const errResult = Result.err('oops');

      // Result.unwrapOk returns the value for Ok results

      assert.isTrue(Result.unwrapOk(okResult) === 42);

      // Result.unwrapOk returns undefined for Err results

      // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
      assert.isTrue(Result.unwrapOk(errResult) === undefined);

    • Safely unwraps the success value, returning undefined for failures.

      Type Parameters

      • R extends UnknownResult

      Parameters

      • result: R

      Returns UnwrapOk<R> | undefined

      const okResult = Result.ok(42);

      const errResult = Result.err('oops');

      // Result.unwrapOk returns the value for Ok results

      assert.isTrue(Result.unwrapOk(okResult) === 42);

      // Result.unwrapOk returns undefined for Err results

      // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
      assert.isTrue(Result.unwrapOk(errResult) === undefined);

    Settings

    Member Visibility