Skip to main content

IBookmark interface

📖 Description​

Describes the interface that holds a bookmark.

📃 Type declaration​

interface IBookmark {
  id: string;Readonly
  section: Section | undefined;Readonly
  context: Context | undefined;Readonly
  label: string;Readonly
  name: string;Readonly
  description: string;Readonly
  level: number;Readonly
  validation: "passed" | "partial" | "failed";Readonly
  nodes: IObservableNode[];Readonly
  bookmarks: IBookmark[];Readonly
}
🖱ī¸ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🗃ī¸ Properties​

🏷ī¸ bookmarks​

Specifies any sub-bookmarks.

Type​

IBookmark[]

🏷ī¸ context​

Contains the context for the bookmark.

Type​

Context | undefined

🏷ī¸ description​

Description for the bookmark.

Type​

string

🏷ī¸ id​

Contains the identifier of the bookmark.

Type​

string

🏷ī¸ label​

Name for the bookmark (this is the name of the bookmark with any markdown processed).

Type​

string

🏷ī¸ level​

Specifies the bookmark (indentation) level (the first level is 1).

Type​

number

🏷ī¸ name​

Name for the bookmark.

Type​

number

🏷ī¸ nodes​

Contains the nodes in the bookmark.

Type​

IObservableNode[]

🏷ī¸ section​

Reference to the section that defined the bookmark.

Type​

Section | undefined

🏷ī¸ validation​

Contains the validation state of the bookmark. Can be one of the following values:

  • passed: All nodes (and sub-bookmarks) passed validation;
  • partial: All nodes of the bookmark passed validation, but one or more sub-bookmarks failed;
  • failed: One or more nodes failed validation.

Type​

"passed" | "partial" | "failed"