Skip to content
2 min read · 409 words

@nhtio/adk/guards

Runtime type guards for ADK primitives, contexts, runners, tools, and artifacts.

Remarks

Type guards for every value-bearing primitive in the ADK. Each is* function is a freestanding TypeScript type predicate (returns value is X) that delegates to the cross-realm-safe @nhtio/adk!isInstanceOf helper.

For internal primitives that are not exported as runtime classes (BaseException, TurnContext, DispatchContext), the freestanding guard here is the canonical runtime detection. For user-constructable classes (Memory, Tool, etc.) these freestanding guards complement the static ClassName.isClassName(value) methods already on each class.

Functions

FunctionDescription
isArtifactToolReturns true if value is an @nhtio/adk!ArtifactTool instance.
isBaseExceptionReturns true if value is a @nhtio/adk!BaseException instance.
isDispatchContextReturns true if value is a @nhtio/adk!DispatchContext instance.
isDispatchRunnerReturns true if value is a @nhtio/adk!DispatchRunner instance.
isErrorReturns true if value is an Error instance or satisfies the Error duck-type shape.
isIdentityReturns true if value is an @nhtio/adk!Identity instance.
isInstanceOfReturns true if value is an instance of the class identified by type (and optionally ctor).
isMemoryReturns true if value is a @nhtio/adk!Memory instance.
isMessageReturns true if value is a @nhtio/adk!Message instance.
isObjectType guard to check if a value is a plain object (not null, not array)
isRegistryReturns true if value is a @nhtio/adk!Registry instance.
isSpooledArtifactReturns true if value is a @nhtio/adk!SpooledArtifact instance.
isSpooledArtifactConstructorReturns true if value is a constructor function for @nhtio/adk!SpooledArtifact or any of its subclasses (including SpooledArtifact itself).
isSpooledJsonArtifactReturns true if value is a @nhtio/adk!SpooledJsonArtifact instance.
isSpooledMarkdownArtifactReturns true if value is a @nhtio/adk!SpooledMarkdownArtifact instance.
isThoughtReturns true if value is a @nhtio/adk!Thought instance.
isTokenizableReturns true if value is a @nhtio/adk!Tokenizable instance.
isToolReturns true if value is a @nhtio/adk!Tool instance.
isToolCallReturns true if value is a @nhtio/adk!ToolCall instance.
isToolRegistryReturns true if value is a @nhtio/adk!ToolRegistry instance.
isTurnContextReturns true if value is a @nhtio/adk!TurnContext instance.
isTurnGateReturns true if value is a @nhtio/adk!TurnGate instance.
isTurnRunnerReturns true if value is a @nhtio/adk!TurnRunner instance.

References

implementsSpoolReader

Re-exports implementsSpoolReader