katanakit-js / IAccessService

Interface: IAccessService

Defined in: src/types/index.ts:982

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

Methods

useCan()

useCan(subject, capability): boolean;

Defined in: src/types/index.ts:983

Parameters

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

Returns

boolean

---

useCapabilitiesFor()

useCapabilitiesFor(role): string[];

Defined in: src/types/index.ts:985

Parameters

Parameter	Type
role	string

Returns

string[]

---

useHasRole()

useHasRole(subject, role): boolean;

Defined in: src/types/index.ts:984

Parameters

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

Returns

boolean

---

useRegisterRole()

useRegisterRole(definition): void;

Defined in: src/types/index.ts:986

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

void

---

useRoles()

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

Defined in: src/types/index.ts:987

Returns

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