Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 978 Bytes

README.md

File metadata and controls

38 lines (25 loc) · 978 Bytes

Permix

npm version You need Permix

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.

Example

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

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 or the examples directory.

License

MIT License - see the LICENSE file for details