Skip to main content
Version: 3.x (deprecated)

Public API reference

The reference below is generated from the TypeScript source with TypeDoc on every documentation build. Use it for complete signatures, types, and adapter options. The guides provide implementation context and executable examples.

Import pathExports
@rbac/rbacRBAC default factory, createTenantRBAC, adapter and middleware exports, public types
@rbac/rbac/adaptersRoleAdapter, MongoRoleAdapter, MySQLRoleAdapter, PostgresRoleAdapter
@rbac/rbac/middlewarescreateExpressMiddleware, createNestMiddleware, createNestGuard, createFastifyMiddleware
@rbac/rbac/helperscallbackWhen, pattern utilities, logging and normalization helpers
@rbac/rbac/schemas or /roles.schemawhenSchema, roleOperationSchema, roleSchema, rolesSchema

For implementation details beyond this historical API summary, consult the v3.0.0 source code.