Class Facet

A facet group in an OPDS 2.0 feed, used to filter or reorder the publications of a feed.

Index

Constructors

Methods

addFacet addLink getLinks getMetadata getTitle toJSON toObject validate fromJson

Constructors

constructor

new Facet(options: FacetOptions): Facet
Creates a new Facet instance.
Parameters
- options: FacetOptions
  The options for the facet group.
Returns Facet
new Facet(title: LanguageMap): Facet
Creates a new Facet instance with a title.
Parameters
- title: LanguageMap
  The title of the facet group (e.g. Language).
Returns Facet

Methods

addFacet

addFacet(
    href: string,
    title: string,
    options?: { active?: boolean; numberOfItems?: number; type?: string },
): Facet
Adds a facet to the group. This is a convenience method for facets linking to OPDS 2.0 feeds.
Parameters
- href: string
  The URL of the facet.
- title: string
  The title of the facet (e.g. English).
- options: { active?: boolean; numberOfItems?: number; type?: string } = {}
  numberOfItems hints at the number of publications for this facet, active marks the facet as currently selected.
Returns Facet
The Facet instance (for chaining).

addLink

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

getLinks

getLinks(): Link[]

Gets the links of the facet group.

Returns Link[]
The array of links.

getMetadata

getMetadata(): FeedMetadata

Gets the metadata of the facet group.

Returns FeedMetadata
The metadata object.

getTitle

getTitle(): LanguageMap

Gets the title of the facet group.

Returns LanguageMap
The title.

toJSON

toJSON(): Record<string, any>

Used by JSON.stringify to serialize the facet group.

Returns Record<string, any>

toObject

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

validate

validate(): string[]

Checks the facet group against the requirements of the OPDS 2.0 specification.

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

`Static`fromJson

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