DOIP Client Library - JavaScript Version
    Preparing search index...

    Interface SearchResults<T>

    Results of a search operation. Contains facets and size properties, and is itself an async iterable iterator for accessing the results. Users should call close to ensure that any underlying network operation is closed.

    interface SearchResults<T> {
        size: number;
        facets?: FacetResult[];
        close(): Promise<void>;
    }

    Type Parameters

    • T

      The type of items in the search results. Either string or DigitalObject.

    Hierarchy

    • AsyncIterableIterator<T>
      • SearchResults
    Index

    Properties

    Methods

    Properties

    size: number

    The total number of items in the search results.

    facets?: FacetResult[]

    Facet results, if faceting was requested.

    Methods

    • Closes this SearchResults, freeing up any resources such as an open DOIP network connection.

      Returns Promise<void>