crouter

Custom objects and providers

Receiving a custom object's queued deliveries, and listing the tools a provider grants.

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

CustomDeliveryStream

interface declared in resources/custom-objects.ts

A single queue connection. EOF (including rotate/unregister/receiver change) ends iteration; reconnect to replay unacknowledged work.

Prop

Type

CustomObjects

class declared in resources/custom-objects.ts

Prop

Type

ProviderToolEntry

type declared in resources/providers.ts

Help-only provider manifest: granted leaves, never transport or credentials.

{ provider: string; display_name: string; status: 'available'; major: number; groups: Array<{ group: string; leaves: Array<{ tool: string; description: string; summary: string; params: unknown[]; output: unknown[]; }>; }>; commands: Array<{ kind: 'branch'; name: string; description: string; whenToUse: string; summary: string; children: unknown[]; }>; } | { provider: string; display_name: string; status: 'installing' | 'install_failed'; error?: string; groups: []; commands: []; }

ReceiveOptions

type declared in resources/custom-objects.ts

Queue streams replay every pending delivery on connect. after is accepted for compatibility but ignored for pending work.

Prop

Type

On this page