Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/security / / EnvSecretsStore
Class: EnvSecretsStore
Defined in: packages/security/src/secrets/stores/env.ts:44
SecretsStore backed by process.env. Read-only by default — enabling allowMutation: true keeps the API workable for tests but still emits a single console.warn per mutation.
Stable
Implements
Constructors
Constructor
new EnvSecretsStore(opts?): EnvSecretsStore;Defined in: packages/security/src/secrets/stores/env.ts:49
Parameters
| Parameter | Type |
|---|---|
opts | EnvSecretsStoreOptions |
Returns
EnvSecretsStore
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
kind | readonly | "env" | packages/security/src/secrets/stores/env.ts:45 |
Methods
delete()
delete(key, _scope?): Promise<void>;Defined in: packages/security/src/secrets/stores/env.ts:111
Parameters
| Parameter | Type |
|---|---|
key | string |
_scope? | SessionScope |
Returns
Promise<void>
Implementation of
get()
get(key, _scope?): Promise<SecretValue | null>;Defined in: packages/security/src/secrets/stores/env.ts:55
Returns the secret if it exists, null otherwise.
Parameters
| Parameter | Type |
|---|---|
key | string |
_scope? | SessionScope |
Returns
Promise<SecretValue | null>
Implementation of
list()
list(_scope?): Promise<readonly SecretMetadata[]>;Defined in: packages/security/src/secrets/stores/env.ts:133
Returns metadata about every key — never the values themselves.
Parameters
| Parameter | Type |
|---|---|
_scope? | SessionScope |
Returns
Promise<readonly SecretMetadata[]>
Implementation of
require()
require(key, _scope?): Promise<SecretValue>;Defined in: packages/security/src/secrets/stores/env.ts:72
Returns the secret or throws. Implementations enforce the per-tool secretsAllowed ACL: if the current tool context disallows key, throw SecretAccessDeniedError.
Parameters
| Parameter | Type |
|---|---|
key | string |
_scope? | SessionScope |
Returns
Promise<SecretValue>
Implementation of
set()
set(
key,
value,
_opts?): Promise<void>;Defined in: packages/security/src/secrets/stores/env.ts:84
Persist a secret. Implementations auto-wrap a plain string into a SecretValue so callers don't have to.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | | string | SecretValue |
_opts? | SecretsSetOptions |
Returns
Promise<void>