Page methods: create, get, list

Reference for Page, one group of Page methods.

Page.create

Creates a Page. Verb page.

TypeScript

interface PageVerbs {
  create(input: PageCreateInput, options?: SB.CallOptions): SB.Call<Page>
}

Emits Page.created.

Inputs

Input	Type	Required	Description
`path`	`string`	required	The path under its Site, such as `/pricing`.
`kind`	`string`		The page type, such as `landing`, `pricing`, or `terms`.
`from`	`string`		Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`.
`site`	Site		A Site serves its Pages, each at its own path.
`template`	Template		A Template fills one Page per Thing or per member of a Collection.

Returns

Output	Type	Required	Description
`page`	Page	required	The Page.

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 page = await $.Page.create({ path: '/' })

Returns one Page by id. Verb page.

TypeScript

interface PageVerbs {
  get(input: PageGetInput, options?: SB.CallOptions): SB.Call<Page>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`page`	Page	required	The Page.

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

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

TypeScript

interface PageVerbs {
  list(input?: PageListInput, options?: SB.CallOptions): SB.ListCall<Page>
}

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
`pages`	list of Page	required	One page of Pages.

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