DeliveryStage

KIT · interface · Type contract

One pipeline stage, identified for reporting and optional observation.

Import

TypeScript

import type { DeliveryStage } from '@jangts/agent-core/kits/delivery';

JavaScript

/** @typedef {import('@jangts/agent-core/kits/delivery').DeliveryStage} DeliveryStage */

Other public entry points:@jangts/agent-core/types, @jangts/agent-core/kits/delivery, @jangts/agent-core/kits.

Definition

interface DeliveryStage<Input, State, Result, StageId>

Type parameters

Type parameter	Constraint	Default type
Input	—	—
State	—	—
Result	—	—
StageId	string	—

Field structure

Field	Type	Required	Description
id	StageId	Required	Read-only. Unique, non-blank stage id in declaration order.
handle	((state: State, context: OperationContext<Input>) => StepOutcome<Result>) | undefined	Optional	Read-only. Handles this stage. Returning complete ends the pipeline immediately; continue moves to the next stage. Omitting the handler makes the stage a named hook that only beforeStage observes.

Examples

• Delivery: sequential delivery with an explicit end: Each delivery stage explicitly continues or completes; once a stage completes, the run ends immediately.

Deliver a piece of text that is already confirmed

Beginner · Node.js

TypeScript

import { Delivery } from '@jangts/agent-core/kits/delivery';
const delivery = Delivery.defineDelivery({
  createState: (input: string) => ({ text: input }),
  stages: [{ id: 'publish', handle: (state: { text: string }) => ({ type: 'complete' as const, value: state.text }) }],
  missingResult: () => new Error('没有可交付结果'),
});
console.log(delivery.deliver('已完成的答复', { signal: new AbortController().signal }));

JavaScript

import { Delivery } from '@jangts/agent-core/kits/delivery';
const delivery = Delivery.defineDelivery({
    createState: (input) => ({ text: input }),
    stages: [{ id: 'publish', handle: (state) => ({ type: 'complete', value: state.text }) }],
    missingResult: () => new Error('没有可交付结果'),
});
console.log(delivery.deliver('已完成的答复', { signal: new AbortController().signal }));

Add a validation stage while keeping the same deliver

Configuration · Node.js

TypeScript

import { Delivery } from '@jangts/agent-core/kits/delivery';
const delivery = Delivery.defineDelivery({
  createState: (input: string) => ({ text: input.trim() }),
  stages: [
    { id: 'check', handle(state: { text: string }) {
      if (!state.text) throw new Error('答复为空');
      return { type: 'continue' as const };
    } },
    { id: 'publish', handle: (state: { text: string }) => ({ type: 'complete' as const, value: state.text }) },
  ],
  beforeStage: ({ stageId }: { stageId: string }) => { console.log('阶段', stageId); },
  missingResult: () => new Error('没有可交付结果'),
});
console.log(delivery.deliver(' 已完成的答复 ', { signal: new AbortController().signal }));

JavaScript

import { Delivery } from '@jangts/agent-core/kits/delivery';
const delivery = Delivery.defineDelivery({
    createState: (input) => ({ text: input.trim() }),
    stages: [
        { id: 'check', handle(state) {
                if (!state.text)
                    throw new Error('答复为空');
                return { type: 'continue' };
            } },
        { id: 'publish', handle: (state) => ({ type: 'complete', value: state.text }) },
    ],
    beforeStage: ({ stageId }) => { console.log('阶段', stageId); },
    missingResult: () => new Error('没有可交付结果'),
});
console.log(delivery.deliver(' 已完成的答复 ', { signal: new AbortController().signal }));

Related policy source

• Interleaved hooks, stage short-circuiting, and cancellation checks

Related definitions

• OperationContext
• StepOutcome