Skip to content

IAccessService

katanakit-js / IAccessService

Defined in: types/core/access.ts:59

Contract of the access-control facade. Pure, no I/O.

useCan(subject, capability): boolean;

Defined in: types/core/access.ts:60

Parameter Type
subject { [key: string]: unknown; id: string | number; roles: string[]; }
subject.id? string | number
subject.roles? string[]
capability string

boolean


useCapabilitiesFor(role): string[];

Defined in: types/core/access.ts:62

Parameter Type
role string

string[]


useHasRole(subject, role): boolean;

Defined in: types/core/access.ts:61

Parameter Type
subject { [key: string]: unknown; id: string | number; roles: string[]; }
subject.id? string | number
subject.roles? string[]
role string

boolean


useRegisterRole(definition): void;

Defined in: types/core/access.ts:63

Parameter Type
definition { capabilities: string[]; label: string; rank: number; slug: string; }
definition.capabilities? string[]
definition.label? string
definition.rank? number
definition.slug? string

void


useRoles(): {
capabilities: string[];
label: string;
rank: number;
slug: string;
}[];

Defined in: types/core/access.ts:64

{ capabilities: string[]; label: string; rank: number; slug: string; }[]