Skip to content

ClientDescriptor

ClientDescriptor<TNames> = object

Defined in: packages/actions/src/types.ts:244

An opaque descriptor passed to the client to configure the useActions hook.

Created by ActionDefinition.client or ComposedActions.client. Contains the action names and the key used to read permission data from loader results.

TNames extends readonly string[] = readonly string[]

_brand: "ActionClientDescriptor"

Defined in: packages/actions/src/types.ts:246

Brand field to distinguish this type at the type level.


actionNames: TNames

Defined in: packages/actions/src/types.ts:248

The list of action names this descriptor covers.


permissionsKey: string

Defined in: packages/actions/src/types.ts:250

The loader-data key where ActionPermissionsMap is stored.