Noun methods: update, delete

Reference for Noun, one group of Noun methods.

Noun.update

Changes the given properties of a Noun. Verb page.

TypeScript

interface NounVerbs {
  update(input: NounUpdateInput, options?: SB.CallOptions): SB.Call<Noun>
}

Emits Noun.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Noun.
`name`	`string`		The singular, capitalized name.
`properties`	`json`		Its properties, each with a name, a type, and whether it is required.
`publishedIn`	Version		The first published Version that serves it; from then on, edits go through a Change and `delete` refuses.

Returns

Output	Type	Required	Description
`noun`	Noun	required	The Noun.

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 noun = await $.Noun.update({ id: 'noun_v0akLUrXCN', name: 'Leaseline' })

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

TypeScript

interface NounVerbs {
  delete(input: NounDeleteInput, options?: SB.CallOptions): SB.Call<Noun>
}

Emits Noun.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`noun`	Noun	required	The Noun.

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 noun = await $.Noun.delete({ id: 'noun_v0akLUrXCN' })