processEffectSubmitCommand()

Creates a process effect submit command.

Import

import { processEffectSubmitCommand } from "@graphrefly/ts/orchestration/work-queue";

Signature

function processEffectSubmitCommand(
  effect: ProcessEffectRequest<TEffect>,
  opts: {
    readonly workId?: string;
    readonly commandId?: string;
    readonly idempotencyKey?: string;
    readonly sourceRefs?: readonly string[];
    readonly policyRefs?: readonly string[];
    readonly metadata?: Record<string, unknown>;
  } = {},
): WorkQueueCommand<OrchestrationQueuedEffectPayload<TEffect>>

Parameters

Parameter	Type	Description
effect	ProcessEffectRequest<TEffect>	effect value used by the helper.
opts	{ readonly workId?: string; readonly commandId?: string; readonly idempotencyKey?: string; readonly sourceRefs?: readonly string[]; readonly policyRefs?: readonly string[]; readonly metadata?: Record<string, unknown>; }	Options that configure the helper.

Returns

The process effect submit command result.

Example

import { processEffectSubmitCommand } from "@graphrefly/ts/orchestration/work-queue";

Source

packages/ts/src/orchestration/work-queue.ts