Skip to content

Interface: SyncOptions<G> ​

Defined in: packages/core/src/sync.ts:64

Write options that record who made the change.

Extends ​

Type Parameters ​

Type ParameterDefault type
G extends stringstring

Properties ​

PropertyTypeDescriptionInherited fromDefined in
actor?RbacActorWho makes the change. Events carry it as actor. Default: getActor() of the engine, if set.ActorOptions.actorpackages/core/src/events.ts:13
dryRun?booleanCompute and return the plan without writing anything. Default: false.-packages/core/src/sync.ts:76
guard?GDefault guard for definitions without a guard. Default: defaultGuard.-packages/core/src/sync.ts:66
prune?booleanDelete roles & permissions that are not in the definition. Roles are pruned per guard + team scope present in the definition; permissions (which are guard-wide) only for guards that have a global (team-less) definition. Other guards and teams are never touched. Default: false.-packages/core/src/sync.ts:74
team?TeamIdDefault team for definitions without a team.-packages/core/src/sync.ts:68

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