ApiSchemasVariables
Variable: highlight
const highlight: object & Typed<{
note?: string;
prefix?: string;
quote: string;
suffix?: string;
}>;Defined in: packages/core/src/schemas/library/annotations.ts:90
A passage marked in a longer text. prefix and suffix find it again when
the quote appears more than once (as W3C Web Annotation's text quote does).
Type Declaration
description
readonly description: "A passage marked in a text, with an optional note." = 'A passage marked in a text, with an optional note.';links
readonly links: object;links.about
readonly about: LinkDeclaration;name
readonly name: "std.highlight" = 'std.highlight';schema
readonly schema: object;schema.properties
readonly properties: object;schema.properties.note
readonly note: object;schema.properties.note.maxLength
maxLength: number = max;schema.properties.note.minLength?
minLength?: number = min;schema.properties.note.type
type: "string";schema.properties.prefix
readonly prefix: object;schema.properties.prefix.maxLength
maxLength: number = max;schema.properties.prefix.minLength?
minLength?: number = min;schema.properties.prefix.type
type: "string";schema.properties.quote
readonly quote: object;schema.properties.quote.maxLength
maxLength: number = max;schema.properties.quote.minLength?
minLength?: number = min;schema.properties.quote.type
type: "string";schema.properties.suffix
readonly suffix: object;schema.properties.suffix.maxLength
maxLength: number = max;schema.properties.suffix.minLength?
minLength?: number = min;schema.properties.suffix.type
type: "string";schema.required
readonly required: readonly ["quote"];schema.type
readonly type: "object" = 'object';title
readonly title: "Highlight" = 'Highlight';