PURISTA API / Modules / @purista/core / SecretStoreBaseClass

Class: SecretStoreBaseClass<ConfigType>

@purista/core.SecretStoreBaseClass

Base class for secret store adapters

Type parameters

Name	Type
ConfigType	extends Record<string, unknown> = {}

Hierarchy

• SecretStoreBaseClass

  ↳ DefaultSecretStore

Implements

• SecretStore

Table of contents

Constructors

• constructor

Properties

• cache
• config
• logger
• name

Methods

• destroy
• getSecret
• removeSecret
• setSecret

Constructors

constructor

• new SecretStoreBaseClass<ConfigType>(name, config): SecretStoreBaseClass<ConfigType>

Type parameters

Name	Type
ConfigType	extends Record<string, unknown> = {}

Parameters

Name	Type
name	string
config	{ [K in string | number | symbol]: (Object & ConfigType)[K] }

Returns

SecretStoreBaseClass<ConfigType>

Defined in

core/SecretStore/SecretStoreBaseClass.impl.ts:19

Properties

cache

• cache: SecretStoreCacheMap

Defined in

core/SecretStore/SecretStoreBaseClass.impl.ts:17

---

config

• config: { [K in string | number | symbol]: ({ [K in keyof ({ enableGet?: boolean | undefined; enableSet?: boolean | undefined; enableRemove?: boolean | undefined; logger?: Logger | undefined; logLevel?: LogLevelName | undefined; enableCache?: boolean | undefined; cacheTtl?: number | undefined; } & ConfigType)]: ({ ...; } & ConfigType)[K]; })[K] }

Defined in

core/SecretStore/SecretStoreBaseClass.impl.ts:13

---

logger

• logger: Logger

Defined in

core/SecretStore/SecretStoreBaseClass.impl.ts:12

---

name

• name: string

name of store

Implementation of

SecretStore.name

Defined in

core/SecretStore/SecretStoreBaseClass.impl.ts:15

Methods

destroy

▸ destroy(): Promise<void>

disconnects and shuts down the secret store

Returns

Promise<void>

Implementation of

SecretStore.destroy

Defined in

core/SecretStore/SecretStoreBaseClass.impl.ts:70

---

getSecret

▸ getSecret(..._secretNames): Promise<Record<string, undefined | string>>

Parameters

Name	Type
..._secretNames	string[]

Returns

Promise<Record<string, undefined | string>>

Implementation of

SecretStore.getSecret

Defined in

core/SecretStore/SecretStoreBaseClass.impl.ts:34

---

removeSecret

▸ removeSecret(_secretName): Promise<void>

Parameters

Name	Type
_secretName	string

Returns

Promise<void>

Implementation of

SecretStore.removeSecret

Defined in

core/SecretStore/SecretStoreBaseClass.impl.ts:46

---

setSecret

▸ setSecret(_secretName, _secretValue): Promise<void>

Parameters

Name	Type
_secretName	string
_secretValue	string

Returns

Promise<void>

Implementation of

SecretStore.setSecret

Defined in

core/SecretStore/SecretStoreBaseClass.impl.ts:58