Skip to content

API Reference

Generated API reference lives under docs/api/ and is produced by:

bash
pnpm docs:api

The docs site build runs API generation first through the root docs:site:build script.

Package Modules

PackageGenerated API target
@kehto/acldocs/api/modules/_kehto_acl.html
@kehto/clidocs/api/modules/_kehto_cli.html
@kehto/pajadocs/api/modules/_kehto_paja.html
@kehto/firewalldocs/api/modules/_kehto_firewall.html
@kehto/runtimedocs/api/modules/_kehto_runtime.html
@kehto/shelldocs/api/modules/_kehto_shell.html
@kehto/servicesdocs/api/modules/_kehto_services.html
@kehto/nipdocs/api/modules/_kehto_nip.html
@kehto/wmdocs/api/modules/_kehto_wm.html

Do not hand-edit generated API files. Update source JSDoc and rerun pnpm docs:api.

Common NIP-5D Cache Targets

The Cache Storage napplet artifact cache is generated from @kehto/nip/5d source exports. Use these links when implementing or reviewing host cache integration:

APIGenerated target
openNappletArtifactCache()docs/api/functions/_kehto_nip..openNappletArtifactCache.html
CacheStorageNappletArtifactCachedocs/api/classes/_kehto_nip..CacheStorageNappletArtifactCache.html
NappletArtifactCachedocs/api/interfaces/_kehto_nip..NappletArtifactCache.html
OpenNappletArtifactCacheOptionsdocs/api/interfaces/_kehto_nip..OpenNappletArtifactCacheOptions.html