@nhtio/adk/batteries/artifacts/yaml

YAML artifact battery: SpooledYamlArtifact and bidirectional converters.

Remarks

Provides structured query tools for YAML documents, both single-document and multi-document streams. Includes converter tools to transform between YAML and JSON representations without materialising the artifact contents.

Requires the optional peer js-yaml@^4.1.1. Install with:

pnpm add js-yaml

Note: decode() on SpooledYamlArtifact instances throws until registerArtifactEncodables() has been called.

Classes

Class	Description
SpooledYamlArtifact	A SpooledArtifact specialisation that adds YAML-aware read operations.

Variables

Variable	Description
jsonToYamlTool	Converter tool: JSON → YAML.
yamlToJsonTool	Converter tool: YAML → JSON.

References

E_YAML_PARSE_ERROR

Re-exports E_YAML_PARSE_ERROR

---

E_YAML_PEER_MISSING

Re-exports E_YAML_PEER_MISSING