![\"npm\"](\"https://img.shields.io/npm/v/nestjs-roles\")
\n \n \n ![\"npm\"](\"https://img.shields.io/npm/dm/nestjs-roles\")
\n \n \n ![\"Code](\"https://qlty.sh/gh/iamolegga/projects/nestjs-roles/coverage.svg\")
\n \n \n ![\"Known](\"https://snyk.io/test/github/iamolegga/nestjs-roles/badge.svg\"){kind=icon}
\n \n \n ![\"Libraries.io\"](\"https://img.shields.io/librariesio/release/npm/nestjs-roles\")
\n \n \n \n \n \n \n
\n \n \n \n \n \n \n
This is the documentation for v0.8. Compatibility with earlier versions:
\n\n| nestjs-roles | NestJS | Node.js |\n| ------------ | --------------- | ------- |\n| v0.8 | 11, 12 | >=22.12 |\n| [v0.7](https://github.com/iamolegga/nestjs-roles/tree/v0.7.0#readme) | 8, 9, 10, 11 | >=18 |\n\n---\n\n## Install\n\n```sh\nnpm i nestjs-roles\n```\n\n## Example\n\nFirst, let's define roles:\n\n```ts\n// role.enum.ts\n\nexport enum Role {\n ADMIN = 'ADMIN',\n USER = 'USER',\n MODERATOR = 'MODERATOR',\n}\n```\n\nLet's say you use [nestjs-session](http://npm.im/nestjs-session) and keep `role` in `session` property object of `request`. So then create guard with `getRole` callback:\n\n```ts\n// roles.guard.ts\n\nimport { ExecutionContext } from '@nestjs/common';\nimport { createRolesGuard } from 'nestjs-roles';\nimport { Role } from './role.enum';\n\nfunction getRole(context: ExecutionContext) {\n const { session } = context.switchToHttp().getRequest();\n\n if (!session) return;\n\n // you can use single role or array of roles\n // if you provide array of roles, the guard will pass if one of roles is in required roles\n return (session as { role?: Role | Role[] }).role;\n}\n\nexport const Roles = createRolesGuard