Site methods: publish
The Site Verbs publish as typed SDK methods, with inputs, result, refusals and an example.
Reference for Site, one group of Site methods.
Site.publish
Publish puts a Site’s current Pages live on its Domains, under its Brand. Verb page.
interface SiteVerbs {
publish(input: SitePublishInput, options?: SB.CallOptions): SB.Call<Site>
}Emits Site.published.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
site | Site | required | The Site to publish. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
site | Site | required | The Site, 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. |
Example
import { $ } from 'startup-builder'
const site = await $.Site.publish({ site: 'site_kqt1HxwFab' })