API Reference

workItemDomainActionProposal()

Creates a work item domain action proposal.

Import

import { workItemDomainActionProposal } from "@graphrefly/ts/solutions/work-item/actions";

Signature

function workItemDomainActionProposal(
	proposalId: string,
	workItemId: string,
	actionKind: WorkItemDomainActionKind,
	opts: Omit<
		Partial<WorkItemDomainActionProposal>,
		"kind" | "proposalId" | "workItemId" | "actionKind"
	> = {},
): WorkItemDomainActionProposal

Parameters

Parameter	Type	Description
`proposalId`	`string`	Stable identifier used by the emitted record.
`workItemId`	`string`	Stable identifier used by the emitted record.
`actionKind`	`WorkItemDomainActionKind`	action kind value used by the helper.
`opts`	`Omit< Partial<WorkItemDomainActionProposal>, "kind" \| "proposalId" \| "workItemId" \| "actionKind" >`	Options that configure the helper.

Returns

The work item domain action proposal result.

Example

import { workItemDomainActionProposal } from "@graphrefly/ts/solutions/work-item/actions";

Source

packages/ts/src/solutions/work-item/actions-builders.ts