PURISTA API / Modules / @purista/nats-state-store / NatsStateStore

Class: NatsStateStore

@purista/nats-state-store.NatsStateStore

A state store for using NATS (with JetStream) as storage.

Example

const config = {
  port: 8222
}

const store = new NatsStateStore({ config })

await store.setState('stateKey',{ myState: 'value' })

let value = await store.getState('stateKey')
console.log(value) // outputs: { stateKey: { myState: 'value' } }

await store.removeState('stateKey')

value = await store.getState('stateKey')
console.log(value) // outputs: undefined

Hierarchy

• StateStoreBaseClass<NatsStateStoreConfig>

  ↳ NatsStateStore

Table of contents

Constructors

• constructor

Properties

• config
• connection
• kv
• logger
• name
• sc

Methods

• destroy
• getState
• getStore
• removeState
• setState

Constructors

constructor

• new NatsStateStore(config?): NatsStateStore

Parameters

Name	Type	Description
config?	Object	-
config.cacheTtl?	number	Cache time to live in ms
config.enableCache?	boolean	Enable cache
config.enableGet?	boolean	Enable generally get method
config.enableRemove?	boolean	Enable generally remove method
config.enableSet?	boolean	Enable generally set method
config.keyValueStoreName?	string	-
config.logLevel?	LogLevelName	A log level for new logger if logger is not set
config.logger?	Logger	A logger instance

Returns

NatsStateStore

Overrides

StateStoreBaseClass&lt;NatsStateStoreConfig&gt;.constructor

Defined in

nats-state-store/src/NatsStateStore.impl.ts:34

Properties

config

• config: Object

Type declaration

Name	Type	Description
cacheTtl?	number	Cache time to live in ms
enableCache?	boolean	Enable cache
enableGet?	boolean	Enable generally get method
enableRemove?	boolean	Enable generally remove method
enableSet?	boolean	Enable generally set method
keyValueStoreName	string	-
logLevel?	LogLevelName	A log level for new logger if logger is not set
logger?	Logger	A logger instance

Inherited from

StateStoreBaseClass.config

Defined in

core/lib/types/core/StateStore/StateStoreBaseClass.impl.d.ts:10

---

connection

• connection: undefined | NatsConnection

Defined in

nats-state-store/src/NatsStateStore.impl.ts:29

---

kv

• kv: undefined | KV

Defined in

nats-state-store/src/NatsStateStore.impl.ts:32

---

logger

• logger: Logger

Inherited from

StateStoreBaseClass.logger

Defined in

core/lib/types/core/StateStore/StateStoreBaseClass.impl.d.ts:9

---

name

• name: string

Inherited from

StateStoreBaseClass.name

Defined in

core/lib/types/core/StateStore/StateStoreBaseClass.impl.d.ts:11

---

sc

• sc: Codec<unknown>

Defined in

nats-state-store/src/NatsStateStore.impl.ts:31

Methods

destroy

▸ destroy(): Promise<void>

Returns

Promise<void>

Overrides

StateStoreBaseClass.destroy

Defined in

nats-state-store/src/NatsStateStore.impl.ts:123

---

getState

▸ getState(...stateNames): Promise<Record<string, unknown>>

Parameters

Name	Type
...stateNames	string[]

Returns

Promise<Record<string, unknown>>

Overrides

StateStoreBaseClass.getState

Defined in

nats-state-store/src/NatsStateStore.impl.ts:70

---

getStore

▸ getStore(): Promise<KV>

Returns

Promise<KV>

Defined in

nats-state-store/src/NatsStateStore.impl.ts:42

---

removeState

▸ removeState(stateName): Promise<void>

Parameters

Name	Type
stateName	string

Returns

Promise<void>

Overrides

StateStoreBaseClass.removeState

Defined in

nats-state-store/src/NatsStateStore.impl.ts:91

---

setState

▸ setState(stateName, stateValue): Promise<void>

Parameters

Name	Type
stateName	string
stateValue	unknown

Returns

Promise<void>

Overrides

StateStoreBaseClass.setState

Defined in

nats-state-store/src/NatsStateStore.impl.ts:107