https://github.com/letstri/permix

🔒 Permix is a lightweight, framework-agnostic, type-safe permissions management library for JavaScript applications on the client and server sides.
https://github.com/letstri/permix

permissions security type-safe typescript

Last synced: about 1 year ago
JSON representation

🔒 Permix is a lightweight, framework-agnostic, type-safe permissions management library for JavaScript applications on the client and server sides.

• Host: GitHub
• URL: https://github.com/letstri/permix
• Owner: letstri
• License: mit
• Created: 2025-01-14T15:48:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-09T09:34:43.000Z (about 1 year ago)
• Last Synced: 2025-04-06T07:36:20.690Z (about 1 year ago)
• Topics: permissions, security, type-safe, typescript
• Language: TypeScript
• Homepage: https://permix.letstri.dev
• Size: 1.05 MB
• Stars: 25
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Permix

[![npm version](https://badge.fury.io/js/permix.svg)](https://npmjs.com/package/permix)

![You need Permix](https://img.shields.io/badge/You_need-Permix-purple)

Permix is a lightweight, framework-agnostic, type-safe permissions management library for JavaScript applications on the client and server sides.

## Documentation

You can find the documentation [here](https://permix.letstri.dev).

## Example

To quick start you only need to write the following code:

```ts

import { createPermix } from 'permix'

const permix = createPermix<{

  post: {

    action: 'read'

  }

}>()

permix.setup({

  post: {

    read: true,

  }

})

permix.check('post', 'read') // true

```

Permix has other powerful features, so here's check out the [docs](https://permix.letstri.dev/docs) or the [examples](https://github.com/letstri/permix/tree/main/examples) directory.

## License

MIT License - see the [LICENSE](https://github.com/letstri/permix/blob/main/LICENSE) file for details