Skip to main content

ExecutablePath

Stentor API Reference

Stentor API Reference / stentor-models/src / ExecutablePath

Interface: ExecutablePath

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

An executable path defines exactly where an incoming request will be routed to.

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

type?​

optional type: "START"

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

Type of path.

Setting type to START changes the request so that handler.start() is called.

Not setting the type passes the request straight through, requiring the new handler to handle the request as is.

intentId​

intentId: string

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

The ID of the handler to forward or redirect the request to

slots?​

optional slots: RequestSlotMap

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

Optional, if redirecting or forwarding to a handler that is expecting slots, set these to pre-populate them on the request.

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