Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/core / / SecretRef

Interface: SecretRef

Defined in: packages/core/src/contracts/secret-ref.ts:9

Parsed shape of a SecretRef URI (scheme:[//authority]/path[?query][#fragment]).

The full grammar lives in @graphorin/security; the type lives here so downstream packages can carry parsed refs without a security dependency.

Stable

Extended by

Properties

PropertyModifierTypeDescriptionDefined in
authority?readonlystringOptional authority component (e.g. host[:port]).packages/core/src/contracts/secret-ref.ts:15
fragment?readonlystringOptional fragment (e.g. JSON-Pointer for nested fields).packages/core/src/contracts/secret-ref.ts:21
pathreadonlystringPath component (without the leading slash for opaque schemes).packages/core/src/contracts/secret-ref.ts:17
queryreadonlyReadonly<Record&lt;string, string&gt;>Parsed query parameters (already percent-decoded).packages/core/src/contracts/secret-ref.ts:19
rawreadonlystringOriginal URI string as supplied by the caller.packages/core/src/contracts/secret-ref.ts:11
schemereadonlystringLowercased scheme ('env', 'keyring', 'file', …).packages/core/src/contracts/secret-ref.ts:13