ApiSchemasVariables
Variable: docBlock
const docBlock: object & Typed<{
checked?: boolean;
image?: {
alt?: string;
blob: {
hash: string;
key?: string;
mime: string;
name?: string;
salt?: string;
size: number;
};
};
language?: string;
mentions?: readonly string[];
position?: string;
text?: string;
type: | "quote"
| "image"
| "paragraph"
| "heading1"
| "heading2"
| "heading3"
| "bullet"
| "numbered"
| "todo"
| "code"
| "divider";
}>;Defined in: packages/core/src/schemas/library/publishing.ts:245
One block of a document, in order by position. A nested list item or a
toggle's contents has a parent block.
Type Declaration
description
readonly description: "One block of a document: a paragraph, heading, list item, image…" = 'One block of a document: a paragraph, heading, list item, image…';links
readonly links: object;links.in
readonly in: LinkDeclaration;links.parent
readonly parent: LinkDeclaration;name
readonly name: "std.doc-block" = 'std.doc-block';schema
readonly schema: object;schema.properties
readonly properties: object;schema.properties.checked
readonly checked: object;schema.properties.checked.description
readonly description: "For a todo" = 'For a todo';schema.properties.checked.type
readonly type: "boolean" = 'boolean';schema.properties.image
readonly image: object & object;Type Declaration
properties
properties: object;properties.alt
alt: object;properties.alt.maxLength
maxLength: number = max;properties.alt.minLength?
minLength?: number = min;properties.alt.type
type: "string";properties.blob
blob: object & object;Type Declaration
properties
properties: object;properties.hash
hash: object;properties.hash.maxLength
maxLength: ... = 64;properties.hash.minLength
minLength: ... = 64;properties.hash.type
type: ...;properties.key
key: object;properties.key.maxLength
maxLength: ... = 22;properties.key.minLength
minLength: ... = 22;properties.key.type
type: ...;properties.mime
mime: object;properties.mime.maxLength
maxLength: ... = max;properties.mime.minLength?
minLength?: ... = min;properties.mime.type
type: ...;properties.name
name: object;properties.name.maxLength
maxLength: ... = max;properties.name.minLength?
minLength?: ... = min;properties.name.type
type: ...;properties.salt
salt: object;properties.salt.maxLength
maxLength: ... = 22;properties.salt.minLength
minLength: ... = 22;properties.salt.type
type: ...;properties.size
size: object;properties.size.minimum
minimum: ... = 0;properties.size.type
type: ...;required
required: readonly ["hash", "size", "mime"];type
type: "object";x-kind
readonly "x-kind": "file";required
required: readonly ["blob"];type
type: "object";x-kind
readonly "x-kind": "image";schema.properties.language
readonly language: object;schema.properties.language.maxLength
maxLength: number = max;schema.properties.language.minLength?
minLength?: number = min;schema.properties.language.type
type: "string";schema.properties.mentions
readonly mentions: object;schema.properties.mentions.items
items: object & object;Type Declaration
maxLength
maxLength: number = max;minLength?
minLength?: number = min;type
type: "string";x-kind
readonly "x-kind": "did";schema.properties.mentions.maxItems
maxItems: number = max;schema.properties.mentions.type
type: "array";schema.properties.position
readonly position: object & object;Type Declaration
maxLength
maxLength: number = max;minLength?
minLength?: number = min;type
type: "string";x-kind
readonly "x-kind": "position";schema.properties.text
readonly text: object;schema.properties.text.maxLength
maxLength: number = max;schema.properties.text.minLength?
minLength?: number = min;schema.properties.text.type
type: "string";schema.properties.type
readonly type: object;schema.properties.type.enum
enum: (
| "quote"
| "image"
| "paragraph"
| "heading1"
| "heading2"
| "heading3"
| "bullet"
| "numbered"
| "todo"
| "code"
| "divider")[];schema.required
readonly required: readonly ["type"];schema.type
readonly type: "object" = 'object';title
readonly title: "Block" = 'Block';topics
readonly topics: readonly ["mentions"];