Skip to content
Shokupan

getStateProperty

getStateProperty<S, K, D>(state, key, defaultValue?): D | S[K]

Defined in: src/util/types.ts:121

Type-safe state getter with optional default value.

Type Parameters

Section titled “Type Parameters”

S

Section titled “S”

S extends Record<string, any>

K

Section titled “K”

K extends string | number | symbol

D

Section titled “D”

D = undefined

Parameters

Section titled “Parameters”

state

Section titled “state”

S

key

Section titled “key”

K

defaultValue?

Section titled “defaultValue?”

D

Returns

Section titled “Returns”

D | S[K]

Example

Section titled “Example”
const userId = getStateProperty(ctx.state, 'userId', 'anonymous');