raceFailure API Reference

Signature

tsSignature

1
export function raceFailure<K extends PropertyKey, E>(
2
  key: K,
3
  error: E,
4
): {
5
  key: K;
6
  error: E;
7
};

Imports

tsImport

1
import { raceFailure } from "@/lib/flow/core/record";
2
import { raceFailure } from "@/lib/flow";

Type Parameters

K

Failing key type.

E

Failure value type.

Parameters

key

Behavior key that failed.

error

Child domain or runtime error.

Returns

Keyed failure payload.

Return type

{
  key: K;
  error: E;
}

Source

tsflow/core/record.ts:208-216

1
export function raceFailure<K extends PropertyKey, E>(
2
  key: K,
3
  error: E,
4
): {
5
  key: K;
6
  error: E;
7
} {
8
  return { key, error };
9
}