Class BaseDocumentCompressorAbstract

Base Document Compression class. All compressors should extend this class.

Hierarchy (view full)

Constructors

constructor

Methods

compressDocuments isBaseDocumentCompressor

Constructors

constructor

Methods

AbstractcompressDocuments

  • compressDocuments(documents, query, callbacks?): Promise<DocumentInterface<Record<string, any>>[]>

  • Abstract method that must be implemented by any class that extends BaseDocumentCompressor. This method takes an array of Document objects and a query string as parameters and returns a Promise that resolves with an array of compressed Document objects.

    Parameters

    • documents: DocumentInterface<Record<string, any>>[]

      An array of Document objects to be compressed.

    • query: string

      A query string.

    • Optionalcallbacks: Callbacks

    Returns Promise<DocumentInterface<Record<string, any>>[]>

    A Promise that resolves with an array of compressed Document objects.

StaticisBaseDocumentCompressor

Settings

Member Visibility

On This Page

Constructors
Methods