Class InitialValueTemplateItemBuilder

A InitialValueTemplateItemBuilder is used to build a document node with an initial value set.

Implements

Serializable<InitialValueTemplateItem>

Index

Methods

clone description getDescription getId getParameters getTemplateId getTitle id parameters serialize templateId title

Methods

clone

clone(withSpec?: InitialValueTemplateItem): InitialValueTemplateItemBuilder
Clone generic view builder (allows for options overriding)
Parameters
- withSpec: InitialValueTemplateItem = {}
  initial value template item builder options. See InitialValueTemplateItemBuilder
Returns InitialValueTemplateItemBuilder
initial value template item builder based on the context and options provided. See InitialValueTemplateItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:164

description

description(description: string): InitialValueTemplateItemBuilder
Set initial value template item description
Parameters
- description: string
  initial value template item description
Returns InitialValueTemplateItemBuilder
initial value template item builder based on description provided. See InitialValueTemplateItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:63

getDescription

getDescription(): InitialValueTemplateItem
Get initial value template item description

Returns InitialValueTemplateItem
initial value template item description. See InitialValueTemplateItem
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:70

getId

getId(): InitialValueTemplateItem
Get initial value template item builder ID

Returns InitialValueTemplateItem
initial value template item ID. See InitialValueTemplateItem
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:40

getParameters

getParameters(): InitialValueTemplateItem
Get initial value template item template parameters

Returns InitialValueTemplateItem
initial value template item parameters. See InitialValueTemplateItem
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:105

getTemplateId

getTemplateId(): InitialValueTemplateItem
Get initial value template item template ID

Returns InitialValueTemplateItem
initial value template item ID. See InitialValueTemplateItem
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:90

getTitle

getTitle(): InitialValueTemplateItem
Get initial value template item title

Returns InitialValueTemplateItem
initial value template item title. See InitialValueTemplateItem
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:55

id

id(id: string): InitialValueTemplateItemBuilder
Set initial value template item builder ID
Parameters
- id: string
  initial value template item ID
Returns InitialValueTemplateItemBuilder
initial value template item based on ID provided. See InitialValueTemplateItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:33

parameters

parameters(parameters: { [key: string]: any }): InitialValueTemplateItemBuilder
Get initial value template item template parameters
Parameters
- parameters: { [key: string]: any }
  initial value template item parameters
Returns InitialValueTemplateItemBuilder
initial value template item builder based on parameters provided. See InitialValueTemplateItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:98

serialize

serialize(options?: SerializeOptions): InitialValueTemplateItem
Serialize initial value template item
Parameters
- options: SerializeOptions = ...
  serialization options. See SerializeOptions
Returns InitialValueTemplateItem
initial value template item object based on the path, index and hint provided in options. See InitialValueTemplateItem
Implementation of Serializable.serialize
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:113

templateId

templateId(templateId: string): InitialValueTemplateItemBuilder
Set initial value template ID
Parameters
- templateId: string
  initial value template item template ID
Returns InitialValueTemplateItemBuilder
initial value template item based builder on template ID provided. See InitialValueTemplateItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:78

title

title(title: string): InitialValueTemplateItemBuilder
Set initial value template item title
Parameters
- title: string
  initial value template item title
Returns InitialValueTemplateItemBuilder
initial value template item based on title provided. See InitialValueTemplateItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/InitialValueTemplateItem.ts:48