raceSuccess API Reference

Signature

tsSignature

1
export function raceSuccess<K extends PropertyKey, V>(
2
  key: K,
3
  value: V,
4
): {
5
  key: K;
6
  value: V;
7
};

Imports

tsImport

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

Type Parameters

K

Winning key type.

V

Winning value type.

Parameters

key

Behavior key that settled successfully.

value

Successful child value.

Returns

Keyed success payload.

Return type

{
  key: K;
  value: V;
}

Source

tsflow/core/record.ts:189-197

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