Component methods: update, delete

Reference for Component, one group of Component methods.

Component.update

Changes the given properties of a Component. Verb page.

TypeScript

interface ComponentVerbs {
  update(input: ComponentUpdateInput, options?: SB.CallOptions): SB.Call<Component>
}

Emits Component.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Component.
`name`	`string`		The name a Template places it by, such as `Pricing`.
`props`	`json`		The schema of the props it accepts.
`region`	`string`		Where it sits: `header`, `section`, `footer`, or `notice`.
`interactive`	`boolean`		True when it runs code in the browser; it still renders a static still without it.

Returns

Output	Type	Required	Description
`component`	Component	required	The Component.

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 component = await $.Component.update({ id: 'component_1qALyfTlfx', name: 'Leaseline' })

Deletes a Component: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface ComponentVerbs {
  delete(input: ComponentDeleteInput, options?: SB.CallOptions): SB.Call<Component>
}

Emits Component.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Component.

Returns

Output	Type	Required	Description
`component`	Component	required	The Component.

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 component = await $.Component.delete({ id: 'component_1qALyfTlfx' })