API Documentation
    Preparing search index...

    Function paginate

    • Returns a section of the given ResultItems.

      The returned section starts at index "options.start" and has got a maximum length of "options.count".

      Type Parameters

      • T extends Readonly<Record<string, any>>

      Parameters

      • items: ResultItems<T>

        Result of a query.

      • Optionaloptions: PaginationOptions

        Options with start/count flags.

        • If "options.start" is not specified, the returned section starts at index 0.
        • If "options.count" is not specified, the returned section ends with the last element of the given query result.
        • If neither "options.start nor "options.count" is specified, the given query result is returned.

      Returns ResultItems<T>

      A section of the given query result.