Skip to content

Graphorin API reference v0.7.0


Graphorin API reference / @graphorin/core / / isToolReturnEnvelope

Function: isToolReturnEnvelope()

ts
function isToolReturnEnvelope<TOutput>(value): value is ToolReturn<TOutput>;

Defined in: packages/core/src/contracts/tool.ts:310

W-115: the ONE guard for the ToolReturn envelope (the executor and the registry example-normalizer both consume it). Brand first; the structural fallback accepts only objects whose OWN enumerable keys all belong to the canonical envelope shape - {output, exitCode} style process results pass through intact.

Type Parameters

Type ParameterDefault type
TOutputunknown

Parameters

ParameterType
valueunknown

Returns

value is ToolReturn<TOutput>

Stable