Worker methods: update, delete

Reference for Worker, one group of Worker methods.

Worker.update

Changes the given properties of a Worker. Verb page.

TypeScript

interface WorkerVerbs {
  update(input: WorkerUpdateInput, options?: SB.CallOptions): SB.Call<Worker>
}

Emits Worker.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Worker.
`name`	`string`		The name the Worker goes by in a Startup.
`instructions`	`text`		How the Worker does its work.

Returns

Output	Type	Required	Description
`worker`	Worker	required	The Worker.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const worker = await $.Worker.update({ id: 'worker_whZFpOKWIV', name: 'Leaseline' })

Deletes a Worker: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface WorkerVerbs {
  delete(input: WorkerDeleteInput, options?: SB.CallOptions): SB.Call<Worker>
}

Emits Worker.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Worker.

Returns

Output	Type	Required	Description
`worker`	Worker	required	The Worker.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const worker = await $.Worker.delete({ id: 'worker_whZFpOKWIV' })