search

nestjsx / nestjs-typeorm-paginate

:page_with_curl: Pagination response object function + types for typeorm + nestjs
MIT License
843 stars 122 forks source link

[doc] wrong comment for countQueries option #875

Open psam44 opened 11 months ago

psam44 commented 11 months ago

In IPaginationOptions:

  /**
   * @default true
   * Turn off pagination count total queries. itemCount, totalItems, itemsPerPage and totalPages will be undefined
   */
  countQueries?: boolean;

The comment is wrong about itemCount and itemsPerPage. Here is an example of what we can have:

  meta: {
    totalItems: undefined,
    itemCount: 24,
    itemsPerPage: 25,
    totalPages: undefined,
    currentPage: 1
  },