Version methods · StartupBuilder

Reference for Version.

Noun	System	Run by
Version	Repositories	Engineering Lead

Version.get

Returns one Version by id. Verb page.

TypeScript

interface VersionVerbs {
  get(input: VersionGetInput, options?: SB.CallOptions): SB.Call<Version>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`version`	Version	required	The Version.

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

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

TypeScript

interface VersionVerbs {
  list(input?: VersionListInput, options?: SB.CallOptions): SB.ListCall<Version>
}

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
`versions`	list of Version	required	One page of 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 versions = await $.Version.list({ limit: 20 })

Deploy points a Startup’s live address at a Version, so every Interface serves that build. Verb page.

TypeScript

interface VersionVerbs {
  deploy(input: VersionDeployInput, options?: SB.CallOptions): SB.Call<Version>
}

Inputs

Input	Type	Required	Description
`version`	Version	required	The Version to serve.

Returns

Output	Type	Required	Description
`version`	Version	required	The Version, now live.

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.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.
`live` when a Secret a Function declares is missing in `live`	`refused`	Clear what the check names, then call it again.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const version = await $.Version.deploy({ version: 'version_4HTEMs14G4' })