{"id":16180575,"url":"https://github.com/tfarras/nestjs-typeorm-pagination","last_synced_at":"2025-03-19T01:31:03.831Z","repository":{"id":56395475,"uuid":"245894632","full_name":"tfarras/nestjs-typeorm-pagination","owner":"tfarras","description":null,"archived":false,"fork":false,"pushed_at":"2020-11-28T20:17:26.000Z","size":73,"stargazers_count":8,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T04:38:38.360Z","etag":null,"topics":["entity","filter","filter-data","nestjs","nestjs-backend","nestjs-library","pagination","query","typeorm"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tfarras.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-08T22:00:45.000Z","updated_at":"2023-09-01T05:45:23.000Z","dependencies_parsed_at":"2022-08-15T18:00:20.099Z","dependency_job_id":null,"html_url":"https://github.com/tfarras/nestjs-typeorm-pagination","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfarras%2Fnestjs-typeorm-pagination","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfarras%2Fnestjs-typeorm-pagination/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfarras%2Fnestjs-typeorm-pagination/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfarras%2Fnestjs-typeorm-pagination/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tfarras","download_url":"https://codeload.github.com/tfarras/nestjs-typeorm-pagination/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243713420,"owners_count":20335567,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["entity","filter","filter-data","nestjs","nestjs-backend","nestjs-library","pagination","query","typeorm"],"created_at":"2024-10-10T06:08:36.894Z","updated_at":"2025-03-19T01:31:03.588Z","avatar_url":"https://github.com/tfarras.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"http://nestjs.com/\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://nestjs.com/img/logo_text.svg\" width=\"150\" alt=\"Nest Logo\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003ch3 align=\"center\"\u003eNestJS TypeORM Pagination\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://nestjs.com\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/built%20with-NestJs-red.svg\" alt=\"Built with NestJS\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n### Installation\n\n```bash\nnpm install @tfarras/nestjs-typeorm-pagination\n```\n\n\n### Pagination Query params\n\n* `_start` - from which row to start on fetch\n* `_limit` - how many rows to take\n* `_sortBy`? - column for sorting\n* `_order`? - order for sorting. Accepted values: `1 | -1 | ASC | DESC`\n\n### Filtration\n\nYou can filter your data by passing columns and values as query params.\nFor the moment we support `Equal` and `In` operator of typeorm.\n\n#### Usage of `Equal`\nTo filter data with `Equal` operator, you can simply add a parameter like `column=value`\n\nExamples:\n\u003cbr/\u003e\n`id=1` \u003cbr/\u003e\n`email=farrastaimoor@gmail.com` \u003cbr /\u003e\n`country=MD` \n\n#### Usage of `In`\nTo filter data with `In` operator, you can add more than one time parameter like `column=value`\n\nExamples:\n\u003cbr /\u003e\n`id=1\u0026\u0026id=2\u0026\u0026id=3` \u003cbr /\u003e\n`country=MD\u0026\u0026country=SE\u0026\u0026country=US`\n\n\u003chr\u003e\n\n### Usage\n\nExtend your entity from `PaginateableBaseEntity` :\n```typescript\n@Entity({ name: 'user' })\nexport class UserEntity extends PaginateableBaseEntity {\n```\n\nAdd parameter decorator to your controller method :\n```typescript\n@Get()\ngetMany(\n  @PgParams() pg: PaginationParams,\n) {...}\n```\n\nAnd now you're able to use pagination:\n```typescript\n...\nimport { PgParams, PaginationParams, Pagination } from '@tfarras/nestjs-typeorm-pagination';\n\n@Get()\ngetMany(\n  @PgParams() pg: PaginationParams,\n): Promise\u003cPagination\u003cUserEntity\u003e\u003e {\n  return UserEntity.findAndPaginate(pg);\n}\n```\n\nYou still have access to [TypeORM Find Options](https://github.com/typeorm/typeorm/blob/master/docs/find-options.md). Just pass them as the second parameter to the `findAndPaginate`\n\nExample: \n```typescript\nUserEntity.findAndPaginate(pg, {\n  where: {\n    firstname: IsNull(),\n  },\n});\n```\n\nExample request:\n```\n/user?_limit=11\u0026_start=0\u0026_sortBy=id\u0026_order=DESC\u0026id=1\u0026id=2\u0026email=farrastaimoor@gmail.com\n```\n\n`Pagination` response: \n```json\n{\n  \"data\": [\n    {\n      \"id\": 2,\n      \"email\": \"farrastaimoor@gmail.com\",\n      \"firstname\": \"Taimoor\",\n      \"lastname\": \"Farras\",\n      \"country\": \"MD\",\n    }\n  ],\n  \"total\": 1,\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfarras%2Fnestjs-typeorm-pagination","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftfarras%2Fnestjs-typeorm-pagination","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfarras%2Fnestjs-typeorm-pagination/lists"}