Skip to content
1 min read · 263 words

@nhtio/adk/spooled_artifact ​

Lazy, line-oriented artifact readers and format-aware spooled artifact subclasses.

Remarks ​

All spooled-artifact primitives in one barrel: @nhtio/adk!SpooledArtifact (the base lazy line-oriented view over a @nhtio/adk!SpoolReader), plus its format-aware subclasses @nhtio/adk!SpooledJsonArtifact and @nhtio/adk!SpooledMarkdownArtifact. These artifacts are designed to keep both runtime memory usage and LLM context-window consumption bounded by reading the backing store on demand rather than materialising it up front.

Classes ​

ClassDescription
SpooledArtifactA lazy, line-oriented view over an arbitrary backing store.
SpooledJsonArtifactA @nhtio/adk!SpooledArtifact specialisation that adds JSON-aware read operations.
SpooledMarkdownArtifactA @nhtio/adk!SpooledArtifact specialisation that adds markdown-aware structural queries.

Interfaces ​

InterfaceDescription
MarkdownCodeEntryA single fenced code block entry in the document's structural index.
MarkdownHeadingEntryA single heading entry in the document's structural index.
MarkdownSectionA section of a markdown document as returned by SpooledMarkdownArtifact.md_sections.
SpoolReaderBacking store contract for a @nhtio/adk!SpooledArtifact.

Type Aliases ​

Type AliasDescription
JsonArtifactFormatThe set of JSON-derived formats that SpooledJsonArtifact can handle.

Functions ​

FunctionDescription
collectArtifactCompatibleIds-
defaultSerialiseDefault serialiser for @nhtio/adk!ArtifactTool handler return values when a descriptor does not provide its own. Exported for reuse by subclass forgeTools overrides.
implementsSpoolReaderReturns true if value implements the SpoolReader interface.
resolveArtifactById-