![\"Nest](\"https://nestjs.com/img/logo_text.svg\"){kind=logo}
\n\n \n
\n A Nest interceptor to display the Link and the Content Range in the response headers.\n
\n\n# NestJS Request Pagination\n\nA simple NestJS interceptor catching query parameters and format a Link Header, based on [GitHub](https://developer.github.com/v3/guides/traversing-with-pagination/) pagination API.\nThis module uses [format-link-header](https://github.com/jonathansamines/format-link-header) node module to build the response Link Header.\n\n## Installation\n\n```bash\nnpm install --save @algoan/nestjs-pagination\n```\n\n## Requirements\n\n- On this version, the API attached with this interceptor needs to return an object:\n\n```json\n{\n \"totalResources\": 1530,\n \"resources\": [ { ... }, ..., { ... }]\n}\n```\n\n- The resource has to be specified in the interceptor constructor\n\n## Limits\n\n- This module does not take into account what is returned in the `resources` property. It may be inconsistent with headers set by the interceptor.\n\n## Quick Start\n\nImport `LinkHeaderInterceptor` next to a controller method.\n\n```typescript\nimport { LinkHeaderInterceptor } from '@algoan/nestjs-pagination';\nimport { Controller, Get, UseInterceptors } from '@nestjs/common';\n\n@Controller()\n/**\n * Controller returning a lot of documents\n */\nclass AppController {\n /**\n * Find all documents\n */\n @UseInterceptors(new LinkHeaderInterceptor({ resource: 'data' }))\n @Get('/data')\n public async findAll(): Promise<{ totalResources: number; resources: DataToReturn[] }> {\n const data: DataToReturn = await model.find(...);\n const count: number = await model.count();\n\n return { totalResources: count, resources: data };\n }\n}\n```\n\nFor instance, if you have 1015 resources, calling `GET /data?page=4&per_page=100` will return:\n\n```\nContent-Range: data 300-399/1015\nLink: ; rel=\"first\", ; rel=\"last\", ; rel=\"next\", ; rel=\"prev\"\n```\n\nIf you use MongoDB as your database, we also provide a `ParamDecorator` you can use to convert the request to a mongo query parameter.\n```typescript\nimport { LinkHeaderInterceptor, MongoPaginationParamDecorator, MongoPagination, Pageable } from '@algoan/nestjs-pagination';\nimport { Controller, Get, UseInterceptors } from '@nestjs/common';\n\n@Controller()\n/**\n * Controller returning a lot of documents\n */\nclass AppController {\n /**\n * Find all documents\n */\n @UseInterceptors(new LinkHeaderInterceptor({ resource: 'data' }))\n @Get('/data')\n public async findAll(@MongoPaginationParamDecorator() pagination: MongoPagination ): Promise