Class UpdateState<State>

State of the current update.

Template: SceneName

Possible scene names

Type Parameters

State extends object
Type that represents the state

Index

Constructors

constructor

new UpdateState<State>(storage, key, scene, scoped?, customStorage?, customKey?): UpdateState<State>
Type Parameters
- State extends object
Parameters
- storage: StateService
- key: string
- scene: null | string
- Optionalscoped: boolean
- OptionalcustomStorage: StateService
- OptionalcustomKey: string
Returns UpdateState<State>
- Defined in packages/dispatcher/src/state/update-state.ts:36

Accessors

scene

get scene(): null | string
Name of the current scene

Returns null | string
- Defined in packages/dispatcher/src/state/update-state.ts:56

Methods

delete

delete(): Promise<void>
Delete the state from the storage

Returns Promise<void>
- Defined in packages/dispatcher/src/state/update-state.ts:172

enter

enter<SceneState, Scene>(scene, params?): Promise<void>
Enter some scene
Type Parameters
- SceneState extends object
- Scene extends Dispatcher<SceneState>
Parameters
- scene: Scene
- Optionalparams: {
      reset?: boolean;
      ttl?: number;
      with?: SceneState;
  }
  - Optionalreset?: boolean
    If currently in a scoped scene, whether to reset the state
    Default
    true
  - Optionalttl?: number
    TTL for the scene (in seconds)
  - Optionalwith?: SceneState
    Initial state for the scene
    
    Note that this will only work if the scene uses the same key delegate as this state.
Returns Promise<void>
- Defined in packages/dispatcher/src/state/update-state.ts:180

exit

exit(reset?): Promise<void>
Exit from current scene to the root
Parameters
- reset: boolean = true
  Whether to reset scene state (only applicable in case this is a scoped scene)
Returns Promise<void>
- Defined in packages/dispatcher/src/state/update-state.ts:234

get

get(fallback, force?): Promise<State>
Retrieve the state from the storage, falling back to default if not found
Parameters
- fallback: State | (() => State)
  Default state value
- Optionalforce: boolean
  Whether to ignore cached state (def. false)
Returns Promise<State>
- Defined in packages/dispatcher/src/state/update-state.ts:75
get(fallback?, force?): Promise<null | State>
Retrieve the state from the storage, falling back to default if not found
Parameters
- Optionalfallback: State | (() => State)
  Default state value
- Optionalforce: boolean
  Whether to ignore cached state (def. false)
Returns Promise<null | State>
- Defined in packages/dispatcher/src/state/update-state.ts:84
get(force?): Promise<null | State>
Retrieve the state from the storage
Parameters
- Optionalforce: boolean
  Whether to ignore cached state (def. false)
Returns Promise<null | State>
- Defined in packages/dispatcher/src/state/update-state.ts:90

merge

merge(state, params?): Promise<State>
Merge the given object to the current state.

Note: If the storage currently has no state, then fallback must be provided.

Basically a shorthand to calling .get(), modifying and then calling .set()
Parameters
- state: Partial<State>
  State to be merged
- params: {
      fallback?: State | (() => State);
      forceLoad?: boolean;
      ttl?: number;
  } = {}
  - Optionalfallback?: State | (() => State)
  - OptionalforceLoad?: boolean
  - Optionalttl?: number
Returns Promise<State>
- Defined in packages/dispatcher/src/state/update-state.ts:140

rateLimit

rateLimit(key, limit, window): Promise<[number, number]>
Rate limit some handler.

When the rate limit exceeds, RateLimitError is thrown.

This is a simple rate-limiting solution that uses the same key as the state. If you need something more sophisticated and/or customizable, you'll have to implement your own rate-limiter.

Note: key is used to prefix the local key derived using the given key delegate.
Parameters
- key: string
  Key of the rate limit
- limit: number
  Maximum number of requests in window
- window: number
  Window size in seconds
Returns Promise<[number, number]>
Tuple containing the number of remaining and unix time in ms when the user can try again
- Defined in packages/dispatcher/src/state/update-state.ts:260

resetRateLimit

resetRateLimit(key): Promise<void>
Reset the rate limit
Parameters
- key: string
  Key of the rate limit
Returns Promise<void>
- Defined in packages/dispatcher/src/state/update-state.ts:305

set

set(state, ttl?): Promise<void>
Set new state to the storage
Parameters
- state: State
  New state
- Optionalttl: number
  TTL for the new state (in seconds)
Returns Promise<void>
- Defined in packages/dispatcher/src/state/update-state.ts:121

throttle

throttle(key, limit, window): Promise<[number, number]>
Throttle some handler.

When the rate limit exceeds, this function waits for it to reset.

This is a simple wrapper over rateLimit, and follows the same logic.

Note: key is used to prefix the local key derived using the given key delegate.
Parameters
- key: string
  Key of the rate limit
- limit: number
  Maximum number of requests in window
- window: number
  Window size in seconds
Returns Promise<[number, number]>
Tuple containing the number of remaining and unix time in ms when the user can try again
- Defined in packages/dispatcher/src/state/update-state.ts:286

Class UpdateState<State>

Template: SceneName

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UpdateState<State>

Accessors

scene

Returns null | string

Methods

delete

Returns Promise<void>

enter

Type Parameters

Parameters

Optionalreset?: boolean

Default

Optionalttl?: number

Optionalwith?: SceneState

Returns Promise<void>

exit

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<State>

Parameters

Returns Promise<null | State>

Parameters

Returns Promise<null | State>

merge

Parameters

Optionalfallback?: State | (() => State)

OptionalforceLoad?: boolean

Optionalttl?: number

Returns Promise<State>

rateLimit

Parameters

Returns Promise<[number, number]>

resetRateLimit

Parameters

Returns Promise<void>

set

Parameters

Returns Promise<void>

throttle

Parameters

Returns Promise<[number, number]>

Settings

On This Page

`Optional`reset?: boolean

`Optional`ttl?: number

`Optional`with?: SceneState

`Optional`fallback?: State | (() => State)

`Optional`forceLoad?: boolean

`Optional`ttl?: number