Setting methods: update, delete

Reference for Setting, one group of Setting methods.

Setting.update

Changes the given properties of a Setting. Verb page.

TypeScript

interface SettingVerbs {
  update(input: SettingUpdateInput, options?: SB.CallOptions): SB.Call<Setting>
}

Emits Setting.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Setting.
`key`	`string`		The name of the choice.
`value`	`json`		The chosen value.
`locked`	`boolean`		True when no holder below may override it.

Returns

Output	Type	Required	Description
`setting`	Setting	required	The Setting.

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 setting = await $.Setting.update({ id: 'setting_mfZPXxFQYD', value: {} })

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

TypeScript

interface SettingVerbs {
  delete(input: SettingDeleteInput, options?: SB.CallOptions): SB.Call<Setting>
}

Emits Setting.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`setting`	Setting	required	The Setting.

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 setting = await $.Setting.delete({ id: 'setting_mfZPXxFQYD' })