Interface IHelpDocProvider

Hierarchy

IHelpDocProvider

Implemented by

DefaultHelpDocProvider

Index

Properties

onChanged

Methods

Properties

onChanged

onChanged: Observable<void>

Methods

addDocument

addDocument(doc: string): Promise<void>

- Defined in docprovider.ts:19
Parameters
- doc: string
Returns Promise<void>

getDocument

getDocument(titleOrIdx: string | number): string

- Defined in docprovider.ts:17
Return the source of a single document.

Parameters
- titleOrIdx: string | number
Returns string

getMetadata

getMetadata(): ReadonlyArray<IDocMetadata | null>

- Defined in docprovider.ts:15
Return the metadata about all the documents.

Returns ReadonlyArray<IDocMetadata | null>

Generated using TypeDoc