Document token renewal options; flag what is not in npm yet
Getting Started gains a Token renewal section (the three auth.renewal*
keys, where they live and why, and a per-backend table of what turning
renewal off actually costs), and Recipes gains recipe 15 with the two
shapes people hit: a script that should exit, and a service that wants
more retry headroom before expiry.
Also marks the renewal keys and the JWT backend as not being in npm 2.1.2
-- the wiki tracks master, and a reader on the published version would
otherwise wonder why an option does nothing.
Every snippet was executed against the client with a stubbed Vault before
being written down: the kubernetes/renewal:false example arms no timer,
the iam example applies fraction 0.25 and increment 3600, and the three
documented validation failures all reject.
Signed-off-by: kurok <22548029+kurok@users.noreply.github.com>
kurok
committed
Aug 31, 2026
6de478a
Document JWT auth backend (Getting Started + GitHub Actions OIDC recipe)
Signed-off-by: kurok <22548029+kurok@users.noreply.github.com>
kurok
committed
Aug 31, 2026
da0010e
Add usage guide, recipes and a comparison with other Node Vault clients
Four pages replacing the default stub:
Home - what the client is and the 30-second integration.
Getting Started - requirements, boot/get/clear, every option, all four
auth backends, first read/write, shutdown.
Recipes - thirteen worked use cases: config at boot, node-config,
Kubernetes, AWS IAM, KV v2, namespaces, rotation, merge-patch, version
management, the raw escape hatch, typed errors, testing without a Vault,
graceful shutdown.
Why this client - how it compares to node-vault, @litehex/node-vault,
hashi-vault-js and vault-api on KV handling, token lifecycle, config
integration and release hygiene.
Every snippet was executed against a stubbed Vault before being written
down, which caught two things the README would have led me to publish:
request() silently ignores a fourth headers argument, and readMetadata()
resolves to the response envelope, so the metadata is under .data.
The comparison was compiled by reading each project's published source,
package metadata and CI config; it is dated and states its scope, since
these facts drift.
kurok
committed
Aug 31, 2026
659faf7