API Reference

scheduledReadinessProjector()

Creates a scheduled readiness projector.

Import

import { scheduledReadinessProjector } from "@graphrefly/ts/orchestration";

Signature

function scheduledReadinessProjector(
	graph: Graph,
	opts: {
		readonly name?: string;
		readonly schedules: readonly Node<ScheduledReadinessRequested>[];
		readonly clocks?: readonly Node<ScheduledReadinessClock>[];
	},
): ScheduledReadinessBundle

Parameters

Parameter	Type	Description
`graph`	`Graph`	Graph that owns the created nodes or projector.
`opts`	`{ readonly name?: string; readonly schedules: readonly Node<ScheduledReadinessRequested>[]; readonly clocks?: readonly Node<ScheduledReadinessClock>[]; }`	Options that configure the helper.

Returns

A node bundle that emits the projected records.

Example

import { scheduledReadinessProjector } from "@graphrefly/ts/orchestration";

Source

packages/ts/src/orchestration/scheduled-readiness.ts