Skip to content

@purista/core v2.0.5


PURISTA API / @purista/core / SecretStore

Interface: SecretStore

Defined in: packages/core/src/core/SecretStore/types/SecretStore.ts:9

Interface definition for a secret store implementation

Properties

getSecret

getSecret: SecretGetterFunction

Defined in: packages/core/src/core/SecretStore/types/SecretStore.ts:18

get a secret

Param

name of secret

Returns

the secret

Throws

UnhandledError


name

name: string

Defined in: packages/core/src/core/SecretStore/types/SecretStore.ts:11

name of store


removeSecret

removeSecret: SecretDeleteFunction

Defined in: packages/core/src/core/SecretStore/types/SecretStore.ts:25

delete a secret

Param

name of secret

Throws

UnhandledError


setSecret

setSecret: SecretSetterFunction

Defined in: packages/core/src/core/SecretStore/types/SecretStore.ts:33

set a secret

Param

name of secret

Param

value of secret

Throws

UnhandledError

Methods

destroy()

destroy(): Promise<void>

Defined in: packages/core/src/core/SecretStore/types/SecretStore.ts:38

disconnects and shuts down the secret store

Returns

Promise<void>