Interface SecretService

Internal service providing secret storage via OS-native credential stores. Not registered in Context -- used internally by DefaultKeyValueService (see dynamic-cli-framework).

interface SecretService {
    deleteSecret(bunSecretName: string): Promise<boolean>;
    getSecret(bunSecretName: string): Promise<string | null>;
    hasSecret(bunSecretName: string): Promise<boolean>;
    setSecret(key: string, value: string): Promise<string>;
}

Index

Methods

deleteSecret getSecret hasSecret setSecret

Methods

deleteSecret

deleteSecret(bunSecretName: string): Promise<boolean>
Delete a secret by its full Bun secret name.
Parameters
- bunSecretName: string
Returns Promise<boolean>
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/SecretService.ts:21

getSecret

getSecret(bunSecretName: string): Promise<string | null>
Retrieve a secret value by its full Bun secret name.
Parameters
- bunSecretName: string
Returns Promise<string | null>
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/SecretService.ts:16

hasSecret

hasSecret(bunSecretName: string): Promise<boolean>
Check if a secret exists by its full Bun secret name.
Parameters
- bunSecretName: string
Returns Promise<boolean>
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/SecretService.ts:26

setSecret

setSecret(key: string, value: string): Promise<string>
Store a secret value. Constructs the Bun secret name from the current scope and key.
Parameters
- key: string
- value: string
Returns Promise<string>
the constructed Bun secret name (used as part of the sentinel value in the key-value Map).
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/SecretService.ts:11

Interface SecretService

Index

Methods

Methods

deleteSecret

Parameters

Returns Promise<boolean>

getSecret

Parameters

Returns Promise<string | null>

hasSecret

Parameters

Returns Promise<boolean>

setSecret

Parameters

Returns Promise<string>

Settings

On This Page