Generated from services/crossfire/node/packages/kernel/src/result.ts at 52bf0279

Definitions#

These TypeScript definitions document server validation. check.object rejects unknown fields. Custom functions and refinements specify additional checks.

Imported definitions#

This module has no local contract dependencies.

FailureCode#

export type FailureCode = 'invalid' | 'unauthorized' | 'forbidden' | 'missing' | 'conflict' | 'limit' | 'native' | 'unavailable' | 'stale_revision' | 'name_collision' | 'capacity' | 'rate_limit' | 'body_too_large' | 'method_not_allowed';

Failure#

export type Failure = {
    code: FailureCode;
    message: string;
    fieldErrors?: Record<string, string>;
};

Related definitions:

Result#

export type Result<T> = {
    ok: true;
    value: T;
} | {
    ok: false;
    error: Failure;
};

Related definitions:

success#

export function success<T>(value: T): Result<T> { return { ok: true, value }; }

Related definitions:

failure#

export function failure<T = never>(code: FailureCode, message: string): Result<T> { return { ok: false, error: { code, message } }; }

Related definitions:

failureError#

export function failureError(error: Failure): Error & Failure { return Object.assign(new Error(error.message), error); }

Related definitions:

Page source Source revisions