@rustresult/result/lib/factory.d.ts

Rust-like Result and ResultAsync for Javascript

import type { Result } from './Result';
/**
 * Creates a `Result` that contains the success value.
 *
 * Examples:
 * ```ts
 * const result1 = Ok(1);
 * const result2 = Ok<number, string>(1);
 * const result3: Result<number, string> = Ok(1);
 * ```
 */
export declare function Ok<T, E = never>(value: T): Result<T, E>;
/**
 * Creates a `Result` that contains the error value.
 *
 * Examples:
 * ```ts
 * const result = Err('Some error message');
 * ```
 */
export declare function Err<E>(error: E): Result<never, E>;
/**
 * Creates a `Result` that contains the error value.
 *
 * Examples:
 * ```ts
 * const result1 = Err<number, string>('Some error message');
 * const result2: Result<number, string> = Err('Some error message');
 * ```
 */
export declare function Err<T, E>(error: E): Result<T, E>;