Interface IPublicationIndexProvider

Provides methods to fetch index data about a publication.

deprecated

Hierarchy

IPublicationIndexProvider

Index

Methods

Methods

fetchPublicationIndex

fetchPublicationIndex(): Promise<IPublicationIndex>

Fetch the full publication index which is a serializable JSON object this object, including all content documents and their content blocks.

Returns Promise<IPublicationIndex>

fetchPublicationIndexedMetadata

fetchPublicationIndexedMetadata(): Promise<IPublicationIndexedMetadata>

Get the indexed metadata for the publication.

Returns Promise<IPublicationIndexedMetadata>

getDocumentIndexProviders

getDocumentIndexProviders(): Promise<IDocumentIndexProvider[]>

Get all IDocumentIndexProvider instances for this publication. The instances can be used for retrieving index data for each document within the publication.

Returns Promise<IDocumentIndexProvider[]>

getPublicationUri

getPublicationUri(): string

The canonical publication URI.

Returns string

Generated using TypeDoc