Skip to main content

Interface: IBookApi

Defined in: Extensions/ExtensionApiTypes.ts:262

Properties​

onDidChangeActiveBook​

onDidChangeActiveBook: IEventApi<{ moduleId: string; } | null>

Defined in: Extensions/ExtensionApiTypes.ts:279

Methods​

getSection()​

getSection(moduleId, sectionId): Promise<BookSectionDto | null>

Defined in: Extensions/ExtensionApiTypes.ts:266

Get a single section by id.

Parameters​

moduleId​

string

sectionId​

string

Returns​

Promise<BookSectionDto | null>

iterateSections()​

iterateSections(opts): Promise<BookIterationResult>

Defined in: Extensions/ExtensionApiTypes.ts:275

Cursor-based iteration over all sections (depth-first).

Parameters​

opts​

IterateBookOpts

Returns​

Promise<BookIterationResult>

listModules()​

listModules(): Promise<BookModuleInfoDto[]>

Defined in: Extensions/ExtensionApiTypes.ts:263

Returns​

Promise<BookModuleInfoDto[]>

listSections()​

listSections(moduleId, parentId?): Promise<BookSectionSummaryDto[]>

Defined in: Extensions/ExtensionApiTypes.ts:269

Get the table of contents (or a subtree) for a book module.

Parameters​

moduleId​

string

parentId?​

string

Returns​

Promise<BookSectionSummaryDto[]>

registerProvider()​

registerProvider(provider): Promise<DisposableHandle>

Defined in: Extensions/ExtensionApiTypes.ts:277

Parameters​

provider​

BookProviderDescriptor

Returns​

Promise<DisposableHandle>