Skip to main content

HistoricalPath

Stentor API Reference

Stentor API Reference / stentor-models/src / HistoricalPath

Interface: HistoricalPath

Defined in: packages/stentor-models/src/Path/Path.ts:41

When compiled, it will move the user back to a previous handler they already visited.

It always calls the start() method of the historical handler.

Extends​

Properties​

actions?​

optional actions: StorageAction[]

Defined in: packages/stentor-models/src/Action/Actionable.ts:12

Inherited from​

Actionable.actions

conditions?​

optional conditions: string | Conditions

Defined in: packages/stentor-models/src/Conditional.ts:73

Conditions to be met.

Can either be a Conditions object or a string such as "foo('bar') || false"

Inherited from​

Conditioned.conditions

historicalIndex​

historicalIndex: number

Defined in: packages/stentor-models/src/Path/Path.ts:47

The number of handlers to go back into the history of.

This is typically just one and can be no more than 10.

data?​

optional data: object

Defined in: packages/stentor-models/src/Path/Path.ts:66

Inherited from​

SharedPath.data

platform?​

optional platform: string

Defined in: packages/stentor-models/src/Path/Path.ts:72

Optional platform filter for the path.

If set, the path will only apply to the specified platform.

Inherited from​

SharedPath.platform