IAccessService
katanakit-js / IAccessService
Interface: IAccessService
Section titled “Interface: IAccessService”Defined in: types/core/access.ts:59
Contract of the access-control facade. Pure, no I/O.
Methods
Section titled “Methods”useCan()
Section titled “useCan()”useCan(subject, capability): boolean;Defined in: types/core/access.ts:60
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
subject |
{ [key: string]: unknown; id: string | number; roles: string[]; } |
subject.id? |
string | number |
subject.roles? |
string[] |
capability |
string |
Returns
Section titled “Returns”boolean
useCapabilitiesFor()
Section titled “useCapabilitiesFor()”useCapabilitiesFor(role): string[];Defined in: types/core/access.ts:62
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
role |
string |
Returns
Section titled “Returns”string[]
useHasRole()
Section titled “useHasRole()”useHasRole(subject, role): boolean;Defined in: types/core/access.ts:61
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
subject |
{ [key: string]: unknown; id: string | number; roles: string[]; } |
subject.id? |
string | number |
subject.roles? |
string[] |
role |
string |
Returns
Section titled “Returns”boolean
useRegisterRole()
Section titled “useRegisterRole()”useRegisterRole(definition): void;Defined in: types/core/access.ts:63
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
definition |
{ capabilities: string[]; label: string; rank: number; slug: string; } |
definition.capabilities? |
string[] |
definition.label? |
string |
definition.rank? |
number |
definition.slug? |
string |
Returns
Section titled “Returns”void
useRoles()
Section titled “useRoles()”useRoles(): { capabilities: string[]; label: string; rank: number; slug: string;}[];Defined in: types/core/access.ts:64
Returns
Section titled “Returns”{
capabilities: string[];
label: string;
rank: number;
slug: string;
}[]