Skip to content

PURISTA API / Modules / @purista/core / SecretStore

Interface: SecretStore

@purista/core.SecretStore

Interface definition for a secret store implementation

Implemented by

Table of contents

Properties

Methods

Properties

getSecret

getSecret: SecretGetterFunction

get a secret

Param

name of secret

Throws

UnhandledError

Defined in

core/SecretStore/types/SecretStore.ts:18


name

name: string

name of store

Defined in

core/SecretStore/types/SecretStore.ts:11


removeSecret

removeSecret: SecretDeleteFunction

delete a secret

Param

name of secret

Throws

UnhandledError

Defined in

core/SecretStore/types/SecretStore.ts:25


setSecret

setSecret: SecretSetterFunction

set a secret

Param

name of secret

Param

value of secret

Throws

UnhandledError

Defined in

core/SecretStore/types/SecretStore.ts:33

Methods

destroy

destroy(): Promise<void>

disconnects and shuts down the secret store

Returns

Promise<void>

Defined in

core/SecretStore/types/SecretStore.ts:38