Class Publication

An OPDS 2.0 publication.

Constructors

constructor

new Publication(options: PublicationOptions): Publication
Creates a new Publication instance.
Parameters
- options: PublicationOptions
  The options for the publication.
Returns Publication
new Publication(identifier: string, title: LanguageMap): Publication
Creates a new Publication instance with identifier and title.
Parameters
- identifier: string
  The unique identifier (URI) of the publication. (e.g. urn:isbn:9780000000002)
- title: LanguageMap
  The title of the publication.
Returns Publication

Methods

addAcquisition

addAcquisition(
    href: string,
    type: string,
    rel?: AcquisitionRel,
    properties?: LinkProperties,
): Publication
Adds an acquisition link to the publication.
Parameters
- href: string
  The URL of the acquisition link.
- type: string
  The media type of the resource (e.g. application/epub+zip).
- rel: AcquisitionRel = 'acquisition'
  The acquisition relation (default: acquisition). See https://specs.opds.io/opds-2.0#53-acquisition-links
- Optionalproperties: LinkProperties
  Additional link properties, such as price or indirectAcquisition (optional).
Returns Publication
The Publication instance (for chaining).

addAuthor

addAuthor(author: string | ContributorObject): Publication
Adds an author to the publication.
Parameters
- author: string | ContributorObject
  The name of the author, or a contributor object.
Returns Publication
The Publication instance (for chaining).

addCollection

addCollection(collection: string | ContributorObject): Publication
Adds a collection the publication belongs to.
Parameters
- collection: string | ContributorObject
  The name of the collection, or a collection object.
Returns Publication
The Publication instance (for chaining).

addContributor

addContributor(
role: ContributorRole,
contributor: string | ContributorObject,
): Publication
Adds a contributor with the given role. Multiple contributors with the same role are collected in a list.
Parameters
- role: ContributorRole
  The role of the contributor (e.g. author, translator, publisher).
- contributor: string | ContributorObject
  The name of the contributor, or a contributor object.
Returns Publication
The Publication instance (for chaining).

addExtra

addExtra(key: string, value: any): Publication
Adds an extra top-level property (e.g. a custom sub-collection) to the publication.
Parameters
- key: string
  The key of the property.
- value: any
  The value of the property.
Returns Publication
The Publication instance (for chaining).

addImage

addImage(
    href: string,
    type?: string,
    size?: { height?: number; width?: number },
): Publication
Adds an image to the images collection of the publication.
Parameters
- href: string
  The URL of the image.
- type: string = 'image/jpeg'
  The media type of the image (default: image/jpeg).
- Optionalsize: { height?: number; width?: number }
  The dimensions of the image in pixels (optional).
Returns Publication
The Publication instance (for chaining).

addLink

addLink(...links: Link[]): Publication
Adds one or more links to the publication.
Parameters
- ...links: Link[]
  The links to add.
Returns Publication
The Publication instance (for chaining).

addLinks

addLinks(links: Link[]): Publication
Adds multiple links to the publication.
Parameters
- links: Link[]
  The links to add.
Returns Publication
The Publication instance (for chaining).

addSelfLink

addSelfLink(href: string): Publication
Adds a self link to the publication, pointing to its OPDS publication document.
Parameters
- href: string
  The URL of the publication document.
Returns Publication
The Publication instance (for chaining).

addSubject

addSubject(subject: string | SubjectObject): Publication
Adds a subject to the publication.
Parameters
- subject: string | SubjectObject
  The subject name, or a subject object.
Returns Publication
The Publication instance (for chaining).

getAcquisitionLinks

getAcquisitionLinks(): Link[]

Gets all acquisition links of the publication.

Returns Link[]
The array of acquisition links.

getIdentifier

getIdentifier(): string | undefined

Gets the identifier of the publication.

Returns string | undefined
The identifier of the publication.

getImages

getImages(): Link[]

Gets the images of the publication.

Returns Link[]
The array of image links.

getLinks

getLinks(): Link[]

Gets the current links of the publication.

Returns Link[]
The array of links.

getMetadata

getMetadata(): PublicationMetadata

Gets the metadata of the publication.

Returns PublicationMetadata
The metadata object.

getOptions

getOptions(): PublicationOptions

Gets the publication options.

Returns PublicationOptions
The publication options.

getSelfLink

getSelfLink(): Link | undefined

Gets the self link of the publication.

Returns Link | undefined
The self link, or undefined if not found.

getTitle

getTitle(): LanguageMap

Gets the title of the publication.

Returns LanguageMap
The title of the publication.

setDescription

setDescription(description: string): Publication
Sets the description of the publication.
Parameters
- description: string
  The description text.
Returns Publication
The Publication instance (for chaining).

setLanguage

setLanguage(language: string | string[]): Publication
Sets the language(s) of the publication.
Parameters
- language: string | string[]
  BCP 47 language tag(s) (e.g. en).
Returns Publication
The Publication instance (for chaining).

setMetadata

setMetadata(metadata: Partial<PublicationMetadata>): Publication
Merges the given fields into the metadata of the publication.
Parameters
- metadata: Partial<PublicationMetadata>
  The metadata fields to set.
Returns Publication
The Publication instance (for chaining).

setMetadataField

setMetadataField<K extends keyof PublicationMetadata>(
key: K,
value: PublicationMetadata[K],
): Publication
Sets a specific metadata field of the publication.
Type Parameters
- K extends keyof PublicationMetadata
Parameters
- key: K
  The key of the metadata field.
- value: PublicationMetadata[K]
  The value to set.
Returns Publication
The Publication instance (for chaining).

setModified

setModified(modified: string): Publication
Sets the last modification date of the publication.
Parameters
- modified: string
  The date in ISO 8601 format.
Returns Publication
The Publication instance (for chaining).

setNumberOfPages

setNumberOfPages(numberOfPages: number): Publication
Sets the number of pages of the publication.
Parameters
- numberOfPages: number
  The number of pages.
Returns Publication
The Publication instance (for chaining).

setPublished

setPublished(published: string): Publication
Sets the publication date of the publication.
Parameters
- published: string
  The date in ISO 8601 format.
Returns Publication
The Publication instance (for chaining).

setPublisher

setPublisher(publisher: string | ContributorObject): Publication
Sets the publisher of the publication.
Parameters
- publisher: string | ContributorObject
  The name of the publisher, or a contributor object.
Returns Publication
The Publication instance (for chaining).

setSeries

setSeries(name: LanguageMap, position?: number, links?: Link[]): Publication
Sets the series the publication belongs to.
Parameters
- name: LanguageMap
  The name of the series.
- Optionalposition: number
  The position of the publication in the series (optional).
- Optionallinks: Link[]
  Links related to the series, e.g. to a feed of the series (optional).
Returns Publication
The Publication instance (for chaining).

setSubtitle

setSubtitle(subtitle: LanguageMap): Publication
Sets the subtitle of the publication.
Parameters
- subtitle: LanguageMap
  The subtitle.
Returns Publication
The Publication instance (for chaining).

setType

setType(type: string): Publication
Sets the schema.org type of the publication.
Parameters
- type: string
  The type URI (e.g. http://schema.org/Book).
Returns Publication
The Publication instance (for chaining).

toJson

toJson(options?: SerializationOptions): string
Converts the publication to an OPDS 2.0 JSON string.
Parameters
- options: SerializationOptions = {}
  Serialization options.
Returns string
The publication as a JSON string.

toJSON

toJSON(): Record<string, any>

Used by JSON.stringify to serialize the publication.

Returns Record<string, any>

toObject

toObject(options?: SerializationOptions): Record<string, any>
Converts the publication to a plain object following the OPDS 2.0 JSON structure. Blank values are removed.
Parameters
- options: SerializationOptions = {}
  Serialization options (only baseUrl is used).
Returns Record<string, any>
The publication as a plain object.

validate

validate(): string[]

Checks the publication against the requirements of the OPDS 2.0 specification.

Returns string[]
A list of problems. An empty list means the publication is valid.

`Static`fromJson

fromJson(json: string | object): Publication
Creates a Publication instance from OPDS 2.0 JSON.
Parameters
- json: string | object
  The JSON string or an already parsed object.
Returns Publication
A new Publication instance.

Class Publication

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Publication

Parameters

Returns Publication

Methods

addAcquisition

Parameters

Returns Publication

addAuthor

Parameters

Returns Publication

addCollection

Parameters

Returns Publication

addContributor

Parameters

Returns Publication

addExtra

Parameters

Returns Publication

addImage

Parameters

Returns Publication

addLink

Parameters

Returns Publication

addLinks

Parameters

Returns Publication

addSelfLink

Parameters

Returns Publication

addSubject

Parameters

Returns Publication

getAcquisitionLinks

Returns Link[]

getIdentifier

Returns string | undefined

getImages

Returns Link[]

getLinks

Returns Link[]

getMetadata

Returns PublicationMetadata

getOptions

Returns PublicationOptions

getSelfLink

Returns Link | undefined

getTitle

Returns LanguageMap

setDescription

Parameters

Returns Publication

setLanguage

Parameters

Returns Publication

setMetadata

Parameters

Returns Publication

setMetadataField

Type Parameters

Parameters

Returns Publication

setModified

Parameters

Returns Publication

setNumberOfPages

Parameters

Returns Publication

setPublished

Parameters

Returns Publication

setPublisher

`Static`fromJson