WorkflowInstance

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:10172

Constructors

Constructor

new WorkflowInstance(): WorkflowInstance

Returns

WorkflowInstance

Properties

id

id: string

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:10173

Methods

pause()

pause(): Promise<void>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:10177

Pause the instance.

Returns

Promise<void>

---

restart()

restart(): Promise<void>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:10189

Restart the instance.

Returns

Promise<void>

---

resume()

resume(): Promise<void>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:10181

Resume the instance. If it is already running, an error will be thrown.

Returns

Promise<void>

---

sendEvent()

sendEvent(__namedParameters): Promise<void>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:10197

Send an event to this instance.

Parameters

__namedParameters

payload

unknown

type

string

Returns

Promise<void>

---

status()

status(): Promise<InstanceStatus>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:10193

Returns the current status of the instance.

Returns

Promise<InstanceStatus>

---

terminate()

terminate(): Promise<void>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:10185

Terminate the instance. If it is errored, terminated or complete, an error will be thrown.

Returns

Promise<void>