Interface ModulePermissionSpec<Area, Action>

interface ModulePermissionSpec<
    Area extends ModulePermissionArea = ModulePermissionArea,
    Action extends string = string,
> {
    key: string;
    actions: Action[];
    reason?: Localizable;
    label?: Localizable;
    required?: boolean;
    metadata?: Record<string, unknown>;
    area?: Area;
}

Type Parameters

Area extends ModulePermissionArea = ModulePermissionArea
Action extends string = string

Index

Properties

key actions reason? label? required? metadata? area?

Properties

key

key: string

actions

actions: Action[]

`Optional`reason

reason?: Localizable

Human-facing explanation for consent/permission UI. Prefer i18n key form over raw strings for localization.

`Optional`label

label?: Localizable

Optional short display label for permission prompts. Prefer i18n key form over raw strings for localization.

`Optional`required

required?: boolean

`Optional`metadata

metadata?: Record<string, unknown>

`Optional`area

area?: Area