> For the complete documentation index, see [llms.txt](https://monordo.gitbook.io/bitfield-permission-manager/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://monordo.gitbook.io/bitfield-permission-manager/introduction.md).
# Introduction
❤️ **This library is developed and maintained by MonOrdo** ❤️
{% hint style="danger" %}
Documentation in progress
{% endhint %}
This library is developed to use the [Bit field](https://en.wikipedia.org/wiki/Bit_field) method as the main logic base within our permission system. We did not invent this method, nor its application to the permission system, but after having been inspired by discord, for example. We chose to simplify its use by creating a library to apply it more simply. This library supports [injection](https://rxjs.dev/) within a module and can therefore be injected, for example, within the services of a [NestJs](https://nestjs.com/) server. This library also exposes a Guard to simplify its use within [NestJs](https://nestjs.com/).
The bit field method allows building a permission system like [Discord](https://discord.com/) uses for its channels. The main advantage is to avoid heavy data transfers on the whole proposed solution. For its use, the storage of a big int is enough. The second advantage is its reliability for the check of permissions, no storage of permissions is necessary except the storage of the big int, so only its interpretation can differ in time and not name migrations as can be found on classical methods.
**Repository:**
**Official documentation:**
**NPM details:**
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://monordo.gitbook.io/bitfield-permission-manager/introduction.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
