Class SearchPaginator

Paginator for searching.

Hierarchy

  • SearchPaginator

Implements

Accessors

[toStringTag] hits max numberOfHits offset phrase

Methods

[asyncIterator] done next toJSON

Accessors

[toStringTag]

  • get [toStringTag](): "SearchPaginator"

  • Returns "SearchPaginator"

hits

max

  • get max(): number

  • The maximal number of hits in this junk. It is a repetition of the input argument max which might have been adapted.

    Returns number

    See

    SearchParameters#max

numberOfHits

offset

  • get offset(): number

  • The offset at which the hits start. It is a repetition of the input argument offset which might have been adapted.

    Returns number

    See

    SearchParameters#offset

phrase

Methods

[asyncIterator]

  • [asyncIterator](): AsyncGenerator<Readonly<SearchHit>, void, undefined>

  • Returns AsyncGenerator<Readonly<SearchHit>, void, undefined>

done

  • Returns boolean

next

toJSON

Settings

Theme

Generated using TypeDoc