Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents an indexed version of a publication in JSON format.

deprecated

Hierarchy

  • IPublicationIndex

Index

Properties

canonicalUri

canonicalUri: string

The canonical URI to this publication.

documents

documents: IDocumentIndex[]

List of all indexed documents.

hasIndexingErrors

hasIndexingErrors: boolean

If there was any error while indexing.

publicationMetadata

publicationMetadata: IPublicationIndexedMetadata

Metadata about the publication

revision

revision: string

A unique string identifying the revision of this indexed publication.

It is RECOMMENDED to create this string by creating a SHA-1 hash of all content in this object and all descendants. The input to the SHA-1 digest algorithm is created by performing a JSON.stringify on all properties in this object, except 'documents' Finally, append the 'revision' string from each indexed document.

Generated using TypeDoc