@purista/dapr-sdk v2.0.5

---

PURISTA API / @purista/dapr-sdk / DaprStateStore

Class: DaprStateStore

Defined in: dapr-sdk/src/DaprStateStore/DaprStateStore.impl.ts:15

DaprStateStore is an adapter which connects to the state store provided by the underlaying Dapr infrastructure

Extends

• StateStoreBaseClass<DaprStateStoreConfig>

Constructors

new DaprStateStore()

new DaprStateStore(config?): DaprStateStore

Defined in: dapr-sdk/src/DaprStateStore/DaprStateStore.impl.ts:18

Parameters

config?

cacheTtl?

number

Cache time to live in ms

clientConfig?

DaprClientConfig

The Dapr client config to interact with Dapr sidecar

enableCache?

boolean

Enable cache

enableGet?

boolean

Enable generally get method

enableRemove?

boolean

Enable generally remove method

enableSet?

boolean

Enable generally set method

logger?

Logger

A logger instance

logLevel?

LogLevelName

A log level for new logger if logger is not set

stateStoreName?

string

The name of the state store

Returns

DaprStateStore

Overrides

StateStoreBaseClass.constructor

Properties

config

config: object

Defined in: core/dist/commonjs/core/StateStore/StateStoreBaseClass.impl.d.ts:16

cacheTtl?

optional cacheTtl: number

Cache time to live in ms

clientConfig?

optional clientConfig: DaprClientConfig

The Dapr client config to interact with Dapr sidecar

enableCache?

optional enableCache: boolean

Enable cache

enableGet?

optional enableGet: boolean

Enable generally get method

enableRemove?

optional enableRemove: boolean

Enable generally remove method

enableSet?

optional enableSet: boolean

Enable generally set method

logger?

optional logger: Logger

A logger instance

logLevel?

optional logLevel: LogLevelName

A log level for new logger if logger is not set

stateStoreName?

optional stateStoreName: string

The name of the state store

Inherited from

StateStoreBaseClass.config

---

logger

logger: Logger

Defined in: core/dist/commonjs/core/StateStore/StateStoreBaseClass.impl.d.ts:15

Inherited from

StateStoreBaseClass.logger

---

name

name: string

Defined in: core/dist/commonjs/core/StateStore/StateStoreBaseClass.impl.d.ts:17

Inherited from

StateStoreBaseClass.name

Methods

destroy()

destroy(): Promise<void>

Defined in: core/dist/commonjs/core/StateStore/StateStoreBaseClass.impl.d.ts:25

Returns

Promise<void>

Inherited from

StateStoreBaseClass.destroy

---

getState()

getState<StateNames>(...stateNames): Promise<ObjectWithKeysFromStringArray<StateNames>>

Defined in: core/dist/commonjs/core/StateStore/StateStoreBaseClass.impl.d.ts:20

Type Parameters

• StateNames extends string[]

Parameters

stateNames

...StateNames

Returns

Promise<ObjectWithKeysFromStringArray<StateNames>>

Inherited from

StateStoreBaseClass.getState

---

getStateImpl()

protected getStateImpl<StateNames>(...stateNames): Promise<ObjectWithKeysFromStringArray<StateNames>>

Defined in: dapr-sdk/src/DaprStateStore/DaprStateStore.impl.ts:53

Type Parameters

• StateNames extends string[]

Parameters

stateNames

...StateNames

Returns

Promise<ObjectWithKeysFromStringArray<StateNames>>

Overrides

StateStoreBaseClass.getStateImpl

---

removeState()

removeState(stateName): Promise<void>

Defined in: core/dist/commonjs/core/StateStore/StateStoreBaseClass.impl.d.ts:22

Parameters

stateName

string

Returns

Promise<void>

Inherited from

StateStoreBaseClass.removeState

---

removeStateImpl()

protected removeStateImpl(stateName): Promise<void>

Defined in: dapr-sdk/src/DaprStateStore/DaprStateStore.impl.ts:99

Parameters

stateName

string

Returns

Promise<void>

Overrides

StateStoreBaseClass.removeStateImpl

---

setState()

setState(stateName, stateValue): Promise<void>

Defined in: core/dist/commonjs/core/StateStore/StateStoreBaseClass.impl.d.ts:24

Parameters

stateName

string

stateValue

unknown

Returns

Promise<void>

Inherited from

StateStoreBaseClass.setState

---

setStateImpl()

protected setStateImpl(stateName, stateValue): Promise<void>

Defined in: dapr-sdk/src/DaprStateStore/DaprStateStore.impl.ts:82

Parameters

stateName

string

stateValue

unknown

Returns

Promise<void>

Overrides

StateStoreBaseClass.setStateImpl