Skip to content

Type Alias: Requirement ​

ts
type Requirement = 
  | {
  all?: boolean;
  permission: Many<string>;
  role?: never;
  roleOrPermission?: never;
}
  | {
  all?: boolean;
  permission?: never;
  role: Many<string>;
  roleOrPermission?: never;
}
  | {
  all?: never;
  permission?: never;
  role?: never;
  roleOrPermission: Many<string>;
};

Defined in: packages/next/src/types.ts:11

What a guard requires — mirrors spatie's permission, role and role_or_permission middleware. Arrays and 'a|b' strings mean "any of" (like permission:a|b / spatie's canAny()). With all: true, every listed permission or role is required (spatie v8.5 canAll()); a 'a|b' entry still means "a or b" within that entry.

Released under the MIT License. Inspired by spatie/laravel-permission.