Noun methods: retire, trace

Reference for Noun, one group of Noun methods.

Noun.retire

Retire removes a published Noun from new Versions; its records, its history and every pinned Version keep serving. Verb page.

TypeScript

interface NounVerbs {
  retire(input: NounRetireInput, options?: SB.CallOptions): SB.Call<NounRetireOutput>
}

Inputs

Input	Type	Required	Description
`noun`	Noun	required	The Noun to retire.

Returns

Output	Type	Required	Description
`version`	Version	required	The new Version, without the Noun.
`noun`	Noun	required	The Noun, now retired from new Versions.

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

Trace lists every Verb, Process, Offer, Dashboard and Version that references a Noun, so an edit or a retire shows its reach first. Verb page.

TypeScript

interface NounVerbs {
  trace(input: NounTraceInput, options?: SB.CallOptions): SB.Call<NounTraceOutput>
}

Inputs

Input	Type	Required	Description
`noun`	Noun	required	The Noun to trace.

Returns

Output	Type	Required	Description
`uses`	`json`	required	Each referencing entry, by kind and id, with the published Versions that serve it.
`noun`	Noun	required	The Noun traced.

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