Setting methods: create, get, list

Reference for Setting, one group of Setting methods.

Setting.create

Creates a Setting. Verb page.

TypeScript

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

Emits Setting.created.

Inputs

Input	Type	Required	Description
`key`	`string`	required	The name of the choice.
`value`	`json`	required	The chosen value.
`locked`	`boolean`		True when no holder below may override it.
`thing`	Thing		The Thing whose choice a Setting holds; everything below it inherits the value unless it sets its own.

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.create({ key: 'Example key', value: {} })

Returns one Setting by id. Verb page.

TypeScript

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

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Setting.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

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.get({ id: 'setting_mfZPXxFQYD' })

Returns Settings, newest first, one page at a time. Verb page.

TypeScript

interface SettingVerbs {
  list(input?: SettingListInput, options?: SB.CallOptions): SB.ListCall<Setting>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`settings`	list of Setting	required	One page of Settings.

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 settings = await $.Setting.list({ limit: 20 })