SAF Documentation

@saflib/secret-store

Abstract Class: SecretStore ​

Extended by ​

Constructors ​

Constructor ​

new SecretStore(): SecretStore

Returns ​

SecretStore

Methods ​

fetchSecretByName() ​

abstract protected fetchSecretByName(name): Promise<ReturnsError<string, SecretStoreError>>>>

Backend-specific fetch; only called after manifest validation.

Parameters ​

ParameterType
namestring

Returns ​

Promise<ReturnsError<string, SecretStoreError>>

getSecretByName() ​

getSecretByName(name, packageSecrets): Promise<ReturnsError<string, SecretStoreError>>>>

Fetch a secret by name after checking it is declared in packageSecrets (typically the package's secrets.json).

Parameters ​

ParameterType
namestring
packageSecretsSecretManifest

Returns ​

Promise<ReturnsError<string, SecretStoreError>>