@publicclassDocumentListItemBuilder
Class for building a document list item
Import
import {DocumentListItemBuilder} from 'sanity/structure'Constructor
@publicnew DocumentListItemBuilder(_context, spec)Constructs a new instance of the DocumentListItemBuilder class
Parameters
_context: StructureContext_context: StructureContextspec: DocumentListItemInputspec: DocumentListItemInputProperties
_context: StructureContext_context: StructureContextStructure context. See StructureContext
spec: PartialDocumentListItemspec: PartialDocumentListItemDocument list options. See PartialDocumentListItem
Methods
clone(withSpec)
Clone Document list item builder (allows for options overriding)
Parameters
withSpec?: PartialDocumentListItemwithSpec?: PartialDocumentListItemDocument list item builder options. See PartialDocumentListItem
Returns
DocumentListItemBuilderDocumentListItemBuilderdocument list item builder. See DocumentListItemBuilder
serialize(options)
Serialize document list item
Parameters
options?: SerializeOptionsoptions?: SerializeOptionsserialization options. See SerializeOptions
Returns
DocumentListItemDocumentListItemdocument list item object based on path provided in options. See DocumentListItem