Skip to main content

Interface: RepoUpdateOptions<T>

Defined in: service-core/src/models/RepoUtils.ts:159

The available options for the RepoUtils.update() operation.

Extends​

Type Parameters​

T​

T extends BaseEntity | SimpleEntity

Properties​

allowReadOnly?​

optional allowReadOnly?: boolean

Defined in: service-core/src/models/RepoUtils.ts:173

Set to true to let this update actually write @ReadOnly fields instead of unconditionally resetting them back to their existing persisted value. Defaults to false (the field is protected), matching this method's behavior prior to this option's introduction.

For trusted server-side code only - this must never be derived from a client request. It exists for a caller that legitimately owns a @ReadOnly field's lifecycle outside the ordinary create/update path (e.g. a background job or route handler computing and persisting a system-managed value), where the alternative would be bypassing RepoUtils.update() entirely (losing its ACL/optimistic-locking/ transaction handling) just to change that one field.

ignoreACL?​

optional ignoreACL?: boolean

Defined in: service-core/src/models/RepoUtils.ts:84

Set to true to ignore the ACL permissions check.

Inherited from​

RepoOperationOptions.ignoreACL

pushChannels?​

optional pushChannels?: string[]

Defined in: service-core/src/models/RepoUtils.ts:86

An additional list of channel names to send push notifications to.

Inherited from​

RepoOperationOptions.pushChannels

recordEvent?​

optional recordEvent?: boolean

Defined in: service-core/src/models/RepoUtils.ts:88

Indicates if a telemetry event should be broadcast for the request.

Inherited from​

RepoOperationOptions.recordEvent

skipPush?​

optional skipPush?: boolean

Defined in: service-core/src/models/RepoUtils.ts:90

Set to true to not send a push notification.

Inherited from​

RepoOperationOptions.skipPush

transaction?​

optional transaction?: TransactionInfo

Defined in: service-core/src/models/RepoUtils.ts:92

The transactional session to execute the operation within.

Inherited from​

RepoOperationOptions.transaction

user?​

optional user?: JWTUser

Defined in: service-core/src/models/RepoUtils.ts:94

The authenticated user making the request.

Inherited from​

RepoOperationOptions.user

version?​

optional version?: string | number

Defined in: service-core/src/models/RepoUtils.ts:161

The desired version number of the resource to update.