Lifecycle methods · StartupBuilder

Reference for Lifecycle.

Lifecycle.get

Returns one Lifecycle by id. Verb page.

TypeScript

interface LifecycleVerbs {
  get(input: LifecycleGetInput, options?: SB.CallOptions): SB.Call<Lifecycle>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`lifecycle`	Lifecycle	required	The Lifecycle.

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 lifecycle = await $.Lifecycle.get({ id: 'lifecycle_DfihmW6mF5' })

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

TypeScript

interface LifecycleVerbs {
  list(input?: LifecycleListInput, options?: SB.CallOptions): SB.ListCall<Lifecycle>
}

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
`lifecycles`	list of Lifecycle	required	One page of Lifecycles.

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

Changes the given properties of a Lifecycle. Verb page.

TypeScript

interface LifecycleVerbs {
  update(input: LifecycleUpdateInput, options?: SB.CallOptions): SB.Call<Lifecycle>
}

Emits Lifecycle.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Lifecycle.
`states`	`string[]`		The states, in order.
`initial`	`string`		The state a new Thing starts in.

Returns

Output	Type	Required	Description
`lifecycle`	Lifecycle	required	The Lifecycle.

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 lifecycle = await $.Lifecycle.update({ id: 'lifecycle_DfihmW6mF5', states: ['Example states'] })