Interface: SyncOptions<G>
Defined in: packages/core/src/sync.ts:64
Write options that record who made the change.
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
G extends string | string |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
actor? | RbacActor | Who makes the change. Events carry it as actor. Default: getActor() of the engine, if set. | ActorOptions.actor | packages/core/src/events.ts:13 |
dryRun? | boolean | Compute and return the plan without writing anything. Default: false. | - | packages/core/src/sync.ts:76 |
guard? | G | Default guard for definitions without a guard. Default: defaultGuard. | - | packages/core/src/sync.ts:66 |
prune? | boolean | Delete 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? | TeamId | Default team for definitions without a team. | - | packages/core/src/sync.ts:68 |
