Key Result methods: update, delete

Reference for Key Result, one group of Key Result methods.

KeyResult.update

Changes the given properties of a Key Result. Verb page.

TypeScript

interface KeyResultVerbs {
  update(input: KeyResultUpdateInput, options?: SB.CallOptions): SB.Call<KeyResult>
}

Emits KeyResult.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Key Result.
`baseline`	`number`		Where the Metric started.
`target`	`number`		Where the Metric must reach.
`deadline`	`date`		When it must reach it.

Returns

Output	Type	Required	Description
`keyResult`	Key Result	required	The Key Result.

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 keyResult = await $.KeyResult.update({ id: 'kr_fN3pcvG8sq', baseline: 1 })

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

TypeScript

interface KeyResultVerbs {
  delete(input: KeyResultDeleteInput, options?: SB.CallOptions): SB.Call<KeyResult>
}

Emits KeyResult.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`keyResult`	Key Result	required	The Key Result.

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 keyResult = await $.KeyResult.delete({ id: 'kr_fN3pcvG8sq' })