wire
@fungi.computer/whistle / wire
Variables
Section titled “Variables”WhistleAvailabilitySchema
Section titled “WhistleAvailabilitySchema”
constWhistleAvailabilitySchema:ZodDiscriminatedUnion<[ZodObject<{status:ZodLiteral<"available">>; },$strict>>,ZodObject<{status:ZodLiteral<"unavailable">>;reason:ZodString; },$strict>>],"status">>
Host-owned availability carried by every discovered agent row.
WhistleJsonValueSchema
Section titled “WhistleJsonValueSchema”
constWhistleJsonValueSchema:ZodType<WhistleJsonValue,unknown,$ZodTypeInternals<WhistleJsonValue,unknown>>>>
The JSON value grammar shared by Whistle transports and App adapters.
WhistleJsonObjectSchema
Section titled “WhistleJsonObjectSchema”
constWhistleJsonObjectSchema:ZodType<WhistleJsonObject,unknown,$ZodTypeInternals<WhistleJsonObject,unknown>>>>
One JSON object, used for action schemas and custom presentation data.
WhistleFailureSchema
Section titled “WhistleFailureSchema”
constWhistleFailureSchema:ZodType<Readonly<{code:string;message:string;details?:WhistleJsonValue; }>,unknown,$ZodTypeInternals<Readonly<{code:string;message:string;details?:WhistleJsonValue; }>,unknown>>>>
General portable failure data for adapters that cross a transport.
WhistleActionSchemaSchema
Section titled “WhistleActionSchemaSchema”
constWhistleActionSchemaSchema:z.ZodType<WhistleActionSchema> > =WhistleJsonObjectSchema
The JSON object shape used by Whistle action schemas.
WhistleAgentProjectionSchema
Section titled “WhistleAgentProjectionSchema”
constWhistleAgentProjectionSchema:z.ZodType<WhistleAgentProjection>>
One neutral agent row emitted by Whistle’s snapshot.agent projection.
WhistleAgentProjectionsSchema
Section titled “WhistleAgentProjectionsSchema”
constWhistleAgentProjectionsSchema:z.ZodType<readonlyWhistleAgentProjection[]>
A neutral Whistle agent projection collection.
interactionTextLimit
Section titled “interactionTextLimit”
constinteractionTextLimit:8192=8192
Longest prompt answer or message an interaction carries.
Functions
Section titled “Functions”parseJsonValue()
Section titled “parseJsonValue()”parseJsonValue(
value):WhistleJsonValue
Parse copied JSON data at an untrusted transport boundary.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”parseJsonObject()
Section titled “parseJsonObject()”parseJsonObject(
value):WhistleJsonObject
Parse a copied JSON object at an untrusted transport boundary.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”parseFailure()
Section titled “parseFailure()”parseFailure(
value):WhistleFailure
Parse failure data without carrying an Error or stack across the wire.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”parseAction()
Section titled “parseAction()”parseAction(
value):WhistleAction
Parse action metadata once before an adapter constructs a Whistle command.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”parseProjections()
Section titled “parseProjections()”parseProjections(
value):WhistleCommandProjections
Parse the Whistle-owned projection metadata supplied by an App.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”parseAvailability()
Section titled “parseAvailability()”parseAvailability(
value):WhistleAvailability
Parse an availability fact while preserving its reason.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”parseCommandDefinition()
Section titled “parseCommandDefinition()”parseCommandDefinition(
value):WhistleCommandDefinition
Parse one data-only command definition before an adapter creates a command.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”parse()
Section titled “parse()”parse(
value): readonlyWhistleAgentProjection[]
Decode an untrusted agent projection collection at the wire boundary.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”readonly WhistleAgentProjection[]
parsePrompt()
Section titled “parsePrompt()”parsePrompt(
value):WhistlePrompt
Parse one interaction prompt at the boundary where a client renders it.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”parseNotice()
Section titled “parseNotice()”parseNotice(
value):WhistleNotice
Parse one interaction notice at the boundary where a client renders it.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”parsePromptAnswer()
Section titled “parsePromptAnswer()”parsePromptAnswer(
prompt,value):string|boolean
Parse the answer a human gave to one prompt before the command sees it.
Parameters
Section titled “Parameters”prompt
Section titled “prompt”unknown
Returns
Section titled “Returns”string | boolean