Variable: err

err: <TError>(error) => Err<never, TError>

Defined in: src/index.ts:61

Creates a failed Result containing the provided error.

Returns an Err wrapping the given error value.

Type Parameters

Type Parameter	Default type	Description
TError	Error	Error value type.

Parameters

Parameter	Type	Description
error	TError	Error to wrap.

Returns

Err<never, TError>

See

ok - Create a successful result.

Examples

Result.err(new Error('something went wrong'))
// => Err(Error: "something went wrong")

function validate(age: number): Result<number, string> {
  if (age < 0) return Result.err('age cannot be negative')
  if (age > 150) return Result.err('invalid age')

  return Result.ok(age)
}

type ValidationError = { field: string; message: string }
const result = Result.err<number, ValidationError>({
  field: 'email',
  message: 'invalid format'
})