js-bao-wss-client / CreateWithAliasOptions
Interface: CreateWithAliasOptions
Options for creating a document with an alias atomically.
Properties
alias
alias:
ResolveAliasParams
The alias to assign atomically during creation.
documentFormat?
optionaldocumentFormat?:1|2
Create a LARGE document (2) instead of an ordinary one, with the same meaning it has on CreateDocumentOptions.documentFormat. Omitted, the request body is exactly what it was before this option existed.
metadata?
optionalmetadata?:unknown
Opaque JSON-serializable metadata blob to attach at creation time (≤ 4 KB serialized UTF-8), with the same meaning it has on CreateDocumentOptions.metadata.
tags?
optionaltags?:string[]
Tags to attach to the document at creation time, with the same meaning and the same limits they have on CreateDocumentOptions.tags (at most ten, each at most 48 characters). Omitted or empty, the request body is exactly what it was before this option existed.
title
title:
string
The display title for the new document.