Skip to main content

Interface: RunRoutePlace

Defined in: packages/core/src/wire/run-route.ts:62

What a place answers for the route. An id the place does not hold rejects with code ERR_UNKNOWN_RUN (404).

Methods​

cancel()​

cancel(id, reason?): Promise<void>

Defined in: packages/core/src/wire/run-route.ts:71

Answered once the cancel is written; the run stays cancelled across restarts.

Parameters​

id​

string

reason?​

string

Returns​

Promise<void>


frames()​

frames(id, since, reference): Promise<AsyncIterable<BotRouteFrame, any, any>>

Defined in: packages/core/src/wire/run-route.ts:67

The run's frames after event since, led by reference. Rejects for an unknown run before any frame.

Parameters​

id​

string

since​

number

reference​

ExecutionReference

Returns​

Promise<AsyncIterable<BotRouteFrame, any, any>>


inspect()​

inspect(id): Promise<ExecutionInspection>

Defined in: packages/core/src/wire/run-route.ts:65

Parameters​

id​

string

Returns​

Promise<ExecutionInspection>


resolve()​

resolve(id, resolutions): Promise<void>

Defined in: packages/core/src/wire/run-route.ts:68

Parameters​

id​

string

resolutions​

ExecutionResolution[]

Returns​

Promise<void>


start()​

start(request, executor): Promise<ExecutionReference>

Defined in: packages/core/src/wire/run-route.ts:64

Admit a run, or attach to the one runId names. executor is the place's URL, <origin><base>.

Parameters​

request​

RunStartRequest

executor​

string

Returns​

Promise<ExecutionReference>


steer()​

steer(id, input, options?): Promise<SteerReceipt>

Defined in: packages/core/src/wire/run-route.ts:69

Parameters​

id​

string

input​

string

options?​
requestId?​

string

Returns​

Promise<SteerReceipt>