Namespace ReadingSystemUtils

Utility functions used by the various reading system modules.

Index

Functions

Functions

fetchAverageAspectRatioFromReaderDocuments

fetchAverageAspectRatioFromReaderDocuments(readerDocuments: IReaderDocument[]): Promise<number | null>

Calculates the average aspect ratio from a list of reader documents

Parameters
- readerDocuments: IReaderDocument[]
Returns Promise<number | null>

isContentLocation

isContentLocation(value: any): value is IContentLocation

Check if the passed value is an instance of ContentLocation.

Parameters
- value: any
Returns value is IContentLocation

isUnresolvedContentLocation

isUnresolvedContentLocation(value: any): value is IUnresolvedContentLocation

Check if the passed value is an instance of UnresolvedContentLocation.

Parameters
- value: any
Returns value is IUnresolvedContentLocation

Generated using TypeDoc