Pular para o conteúdo principal
Versão descontinuada. Recomendamos migrar para a 4.x (latest). Consulte os guias: 2.x para 3.x · 3.x para 4.x.
Versão: 2.x (deprecated)

Referência da API — 2.2.3

Este conteúdo é uma referência histórica baseada nas declarações TypeScript publicadas na 2.2.3, separada da API 3.x gerada por TypeDoc.

APIContrato na 2.2.3
RBAC<P>(config?)(roles)Cria a instância de autorização.
auth.can(role, operation, params?)Retorna Promise<boolean>; operação aceita string | RegExp.
auth.updateRoles(roles)Atualiza os papéis em memória.
auth.addRole(name, role)Adiciona ou substitui um papel.
Role<P>{ can: Array<string | { name, when }>, inherits?: string[] }.
When<P>Booleano, promise, predicado ou callback Node.js.
RBACConfiglogger?, enableLogger?, colors?.
createTenantRBAC(adapter, tenantId, config?)Cria uma instância com papéis do tenant.
createExpressMiddleware, createNestMiddleware, createFastifyMiddlewareFactories exportadas pela raiz do pacote.
ts
import RBAC from '@rbac/rbac';

const auth = RBAC<{ approved: boolean }>()({
  reviewer: { can: [{ name: 'reviews:accept', when: ({ approved }) => approved }] }
});

console.log(await auth.can('reviewer', 'reviews:accept', { approved: true })); // true

O mapa de exports da 2.2.3 contém somente a raiz. Subcaminhos como @rbac/rbac/helpers, /schemas e o guard NestJS integram a 3.x, não esta versão histórica.