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

Referência da API — 1.1.0

Esta é uma referência histórica baseada no pacote e README publicados na versão 1.1.0, separada do TypeDoc gerado para a 3.x.

APIDescrição
require('@rbac/rbac')Carrega a factory JavaScript.
RBAC(config?)(roles)Cria uma instância de autorização.
roles[role].canPermissões em string ou entradas condicionais { name, when }.
roles[role].inheritsArray opcional de papéis herdados.
auth.can(role, operation, params?)Verifica a autorização de maneira assíncrona.
config.enableLoggerHabilita ou desabilita logs.
config.loggerCustomiza a função de logging.
js
const RBAC = require('@rbac/rbac');
const auth = RBAC({ enableLogger: false })({
  viewer: { can: ['reports:read'] }
});

auth.can('viewer', 'reports:read').then(console.log); // true

Declarações TypeScript, addRole, updateRoles, adapters de banco e middlewares não integram a API publicada da 1.x. Consulte o guia de migração 1.x → 2.x.