function define
define<Code extends string>(
code: Code,
message: string,
defineOptions?: DefineOptions<undefined>
):
FailureFactory<Code, undefined>
& ((
data?: undefined,
options?: FailureOptions
) => Failure<Code, undefined>)

define() overload for failures that carry no payload.

Type Parameters

Code extends string

Parameters

code: Code
message: string
optional
defineOptions: DefineOptions<undefined>

Return Type

FailureFactory<Code, undefined>
& ((
data?: undefined,
options?: FailureOptions
) => Failure<Code, undefined>)
define<Code extends string, Data>(
code: Code,
message: (data: Data) => string,
defineOptions?: DefineOptions<Data>
): FailureFactory<Code, Data>

define() overload for failures whose message is derived from their payload.

Type Parameters

Code extends string
Data

Parameters

code: Code
message: (data: Data) => string
optional
defineOptions: DefineOptions<Data>

Return Type

Usage

import { define } from "lib/result/failure.ts";