Type Alias: DeploymentStreamHandlers
ts
type DeploymentStreamHandlers = object;What a caller wants to hear about while streaming a deployment.
Properties
onDeployment()?
ts
optional onDeployment: (event) => void;Parameters
| Parameter | Type |
|---|---|
event | DeploymentStreamEventOf<"deployment"> |
Returns
void
onEndpoint()?
ts
optional onEndpoint: (event) => void;One of the deployment's endpoints and whether it currently answers. Sent for every endpoint on open, then whenever reachability changes — several ports of one op share a tunnel and so are restated together.
Parameters
| Parameter | Type |
|---|---|
event | DeploymentStreamEventOf<"endpoint"> |
Returns
void
onError()?
ts
optional onError: (error) => void;Parameters
| Parameter | Type |
|---|---|
error | unknown |
Returns
void
onEvent()?
ts
optional onEvent: (event) => void;A new entry in the deployment's event log.
Parameters
| Parameter | Type |
|---|---|
event | DeploymentStreamEventOf<"event"> |
Returns
void
onJob()?
ts
optional onJob: (event) => void;Parameters
| Parameter | Type |
|---|---|
event | DeploymentStreamEventOf<"job"> |
Returns
void
onJobs()?
ts
optional onJobs: (event) => void;The authoritative set of the deployment's active jobs, by id, sent once when the stream opens (ahead of the per-job frames). Prune any active job still shown whose id is absent here: a completion missed while disconnected is not replayed as a job frame, so this is the only signal that it is gone.
Parameters
| Parameter | Type |
|---|---|
event | DeploymentStreamEventOf<"jobs"> |
Returns
void
onOpen()?
ts
optional onOpen: () => void;The stream opened, or reopened after dropping: resynchronise from here.
Returns
void
onTask()?
ts
optional onTask: (event) => void;Parameters
| Parameter | Type |
|---|---|
event | DeploymentStreamEventOf<"task"> |
Returns
void