API Reference

validateWorkItemEffectPlan()

Validates work item effect plan input.

Import

import { validateWorkItemEffectPlan } from "@graphrefly/ts/solutions/work-item/scheduling";

Signature

function validateWorkItemEffectPlan(
	proposal: WorkItemEffectPlanProposed<TInput> | unknown,
	workItem: WorkItemProjection<TInput> | undefined,
	policy: WorkItemEffectPlanPolicy = {},
): readonly DataIssue[]

Parameters

Parameter	Type	Description
`proposal`	`WorkItemEffectPlanProposed<TInput> \| unknown`	Proposal to admit, issue, or project.
`workItem`	`WorkItemProjection<TInput> \| undefined`	work item value used by the helper.
`policy`	`WorkItemEffectPlanPolicy`	Policy object used to admit, retry, or route work.

Returns

Validation diagnostics or the validated projection.

Example

import { validateWorkItemEffectPlan } from "@graphrefly/ts/solutions/work-item/scheduling";

Source

packages/ts/src/solutions/work-item/scheduling-effect-plan-validation.ts