Class StaticSecretsAdapter

This adapter is constructed with a static set of secrets and that static set of secrets is always directly returned when loading secrets.

This is primarily designed for the following use cases:

Providing default values for secrets, which are intended to be overridden in following adapters (in the adapters array given to an instance of UpdatingSecrets).
Setting mock secret values for testing purposes.

Hierarchy (View Summary)

BaseSecretsAdapter
- StaticSecretsAdapter

Index

Constructors

Properties

adapterName staticSecrets

Methods

destroy loadSecrets

Constructors

constructor

new StaticSecretsAdapter(
staticSecrets: Record<string, JsonCompatibleValue>,
): StaticSecretsAdapter
Parameters
- staticSecrets: Record<string, JsonCompatibleValue>
  Static secrets that will always be directly returned as the latest set of loaded secrets.
Returns StaticSecretsAdapter
Overrides BaseSecretsAdapter.constructor
- Defined in src/adapters/static-secrets.adapter.ts:17

Properties

`Readonly`adapterName

adapterName: string

`Protected` `Readonly`staticSecrets

staticSecrets: Record<string, JsonCompatibleValue>

Static secrets that will always be directly returned as the latest set of loaded secrets.

Methods

destroy

destroy(): void
Clean up all resources created by the adapter. This should not cause the adapter to destroy any resources passed to it in its constructor.

Returns void
Inherited from BaseSecretsAdapter.destroy
- Defined in src/adapters/base.adapter.ts:38

loadSecrets

loadSecrets(): Record<string, JsonCompatibleValue>
Directly returns the static secrets given.

Returns Record<string, JsonCompatibleValue>
Overrides BaseSecretsAdapter.loadSecrets
- Defined in src/adapters/static-secrets.adapter.ts:25