Documentation
    Preparing search index...

    Variable DeferredResult

    DeferredResult: {
        Deferred: <T, E>(value: T) => DeferredResult<T, E>;
        Err: <T, E>(error?: E) => DeferredResult<T, E>;
        isDeferred: <T, E>(
            result: DeferredResult<T, E>,
        ) => result is { deferred: true; ok: true; value: T };
        isErr: <T, E>(result: Result<T, E>) => result is { error: E; ok: false };
        isOk: <T, E>(result: Result<T, E>) => result is { ok: true; value: T };
        isUnknownError: <T, E>(
            result: Result<T, E>,
        ) => result is { error: never; ok: false };
        Ok: <T, E>(deferred: boolean, value?: T) => DeferredResult<T, E>;
    }

    Type Declaration

    • Deferred: <T, E>(value: T) => DeferredResult<T, E>
    • Err: <T, E>(error?: E) => DeferredResult<T, E>
    • isDeferred: <T, E>(
          result: DeferredResult<T, E>,
      ) => result is { deferred: true; ok: true; value: T }
    • isErr: <T, E>(result: Result<T, E>) => result is { error: E; ok: false }

      Check if a Result is an error.

    • isOk: <T, E>(result: Result<T, E>) => result is { ok: true; value: T }

      Check if a Result is OK.

    • isUnknownError: <T, E>(result: Result<T, E>) => result is { error: never; ok: false }

      Check if a Result is an unknown error (error field is undefined).

    • Ok: <T, E>(deferred: boolean, value?: T) => DeferredResult<T, E>