Interface IEpubPublicationMetadata

Contains all metadata items extracted from a publication plus EPUB specific metadata (namely media overlays metadata and unique identifier).

Hierarchy

IPublicationMetadata
- IEpubPublicationMetadata

Index

Methods

Methods

getAll

getAll(): IPublicationMetadataItem[]

Inherited from IPublicationMetadata.getAll

Get a list of all available metadata items.

Returns IPublicationMetadataItem[]

getIdentifiers

getIdentifiers(): IPublicationMetadataItem[]

Inherited from IPublicationMetadata.getIdentifiers

Get a list of all publication identifiers.

Returns IPublicationMetadataItem[]

getLanguages

getLanguages(): IPublicationMetadataItem[]

Inherited from IPublicationMetadata.getLanguages

Get a list of all language metadata items.

Returns IPublicationMetadataItem[]

getMediaOverlayMetadata

getMediaOverlayMetadata(): IMediaOverlayMetadata

Gets the metadata found in the OPF related to EPUB media overlays.

Returns IMediaOverlayMetadata

getTitles

getTitles(): IPublicationMetadataItem[]

Inherited from IPublicationMetadata.getTitles

Get a list of all titles of this publication.

Returns IPublicationMetadataItem[]

getUniqueIdentifier

getUniqueIdentifier(): IPublicationMetadataItem

The unique identifier for the publication, as defined by the "unique-identifier" attribute on the element in the OPF file.

Returns IPublicationMetadataItem

toJSON

toJSON(): IEpubPublicationMetadataData

Overrides IPublicationMetadata.toJSON

Get all metadata items as a plain JSON object.

Returns IEpubPublicationMetadataData

Generated using TypeDoc