Skip to content

GramIO API Reference / @gramio/scenes/dist / ScenesStorageData

Interface: ScenesStorageData<Params, State>

Defined in: scenes/index.d.ts:267

Type Parameters

Type ParameterDefault type
Paramsany
Stateany

Properties

PropertyTypeDescriptionDefined in
entered?booleantrue once scene.onEnter has fired for this occupancy of the scene. Used to distinguish "scene first entry" (fire onEnter) from "step transition with firstTime=true" (don't re-fire onEnter). Defaults to false on initial entry and is set true by dispatchActive after onEnter runs.scenes/index.d.ts:282
firstTimeboolean-scenes/index.d.ts:273
namestring-scenes/index.d.ts:268
paramsParams-scenes/index.d.ts:269
parentStack?ParentSceneFrame[]-scenes/index.d.ts:274
previousStepIdstring | number-scenes/index.d.ts:272
stateState-scenes/index.d.ts:270
stepIdstring | number-scenes/index.d.ts:271