crouter

Nodes

Creating a node, messaging it, cancelling it, and reading the outcome it reports.

Exports of @north-light/crouter-sdk, read from the TypeScript compiler at build time. Types re-exported from @north-light/crouter-api are documented with that package.

CancelParams

type declared in types.ts

What nodes.cancel closes, including whether to cascade to descendants.

Prop

Type

MessageParams

type declared in types.ts

A message to a running node. The sender is filled in by the client.

Prop

Type

NodeCreateParams

type declared in types.ts

The daemon's create request, widening output_schema to accept schema objects.

Prop

Type

NodeOutcomeOptions

interface declared in types.ts

Options for one outcome poll.

Prop

Type

ParsedOutcome

type declared in types.ts

The outcome of a parse run, with the structured result typed from the schema.

(((NodeOutcomeBaseDTO & { kind: 'failure'; reason: 'declined'; declined: import("@north-light/crouter-api").DeclinedResultDTO | null; }) | (NodeOutcomeBaseDTO & { kind: 'failure'; reason: Exclude<import("@north-light/crouter-api").TerminalReasonDTO, 'declined'>; declined: null; })) & { output_parsed: null; }) | (NodeOutcomeBaseDTO & { kind: 'result'; reason: import("@north-light/crouter-api").TerminalReasonDTO; declined: null; } & { output_parsed: T; })

On this page