Classes · @purista/nats-config-store

NatsConfigStore

Config store backed by a NATS JetStream key-value bucket.

@purista/nats-config-storeSource

Signature

NatsConfigStore.tstypescript
class NatsConfigStore

Examples

example-1.tstypescript
const store = new NatsConfigStore({
  servers: 'nats:___PH0___
  keyValueStoreName: 'purista-config-store',
})

await store.setConfig('tenant.acme.prod.app.features', { checkout: true })
const config = await store.getConfig('tenant.acme.prod.app.features')
await store.destroy()

Constructors

1 entry

constructor

Constructor

Source
constructor.tstypescript
new constructor(config?: { cacheTtl: number; enableCache: boolean; enableGet: boolean; enableRemove: boolean; enableSet: boolean; keyValueStoreName: string; ... })

Creates a NATS JetStream-backed config store.

Properties

7 entries

cache

Property

cache.tstypescript
cache: ConfigStoreCacheMap

Optional local cache used by store implementations that opt in.

config

Property

config.tstypescript
config: { cacheTtl: number; enableCache: boolean; enableGet: boolean; enableRemove: boolean; enableSet: boolean; keyValueStoreName: string; ... }

Store configuration including operation toggles and cache settings.

connection

Property

Source
connection.tstypescript
connection: NatsConnection | undefined

Active NATS connection, created lazily by `getStore`.

kv

Property

Source
kv.tstypescript
kv: KV | undefined

Cached JetStream key-value bucket handle.

logger

Property

logger.tstypescript
logger: Logger

Child logger scoped to the store name.

name

Property

name.tstypescript
name: string

Store name used in logs and diagnostics.

sc

Property

Source
sc.tstypescript
sc: Codec<unknown>

JSON codec used to encode and decode values in the key-value bucket.

Methods

8 entries

destroy

Method

Source
destroy.tstypescript
destroy(): Promise<void>

Drains and closes the NATS connection and clears cached handles.

getConfig

Method

getConfig.tstypescript
getConfig<ConfigNames>(...configNames: ConfigNames): Promise<ObjectWithKeysFromStringArray<ConfigNames>>

Returns the values for given config properties.

getConfigImpl

Method

Source
getConfigImpl.tstypescript
getConfigImpl<ConfigNames>(...stateNames: ConfigNames): Promise<ObjectWithKeysFromStringArray<ConfigNames>>

This method must be overwritten by actual store implementation.

getStore

Method

Source
getStore.tstypescript
getStore(): Promise<KV>

Returns a healthy JetStream key-value bucket handle.

removeConfig

Method

removeConfig.tstypescript
removeConfig(configName: string): Promise<void>

Removes the config item given by config name.

removeConfigImpl

Method

Source
removeConfigImpl.tstypescript
removeConfigImpl(stateName: string): Promise<void>

This method must be overwritten by actual store implementation.

setConfig

Method

setConfig.tstypescript
setConfig(configName: string, configValue: unknown): Promise<void>

Sets a config value.

setConfigImpl

Method

Source
setConfigImpl.tstypescript
setConfigImpl(stateName: string, stateValue: unknown): Promise<void>

This method must be overwritten by actual store implementation.