requireStateProperty

requireStateProperty<S, K>(state, key, message?): asserts state is S & Record<K, NonNullable<S[K]>>

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

Runtime assertion that a state property exists. Throws an error if the property is missing.

Type Parameters

S

S extends Record<string, any>

K

K extends string | number | symbol

Parameters

state

S

key

K

message?

string

Returns

asserts state is S & Record<K, NonNullable<S[K]>>

Example

requireStateProperty(ctx.state, 'userId');
// Now TypeScript knows ctx.state.userId exists
const id = ctx.state.userId;