Skip to main content

Interface: RepoFindOptions

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

The available options used for RepoUtils operations.

Extends​

Properties​

action?​

optional action?: string

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

Overrides the ACLAction checked for this operation instead of its usual default (COUNT for count(), LIST for find(), READ for findOne()). Used by callers layering a different operation on top of one of these (e.g. exists() checking ACLAction.EXISTS instead of COUNT when reusing count()).

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

includeDeleted?​

optional includeDeleted?: boolean

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

Set to true to include soft-deleted RecoverableBaseEntity rows/documents that would otherwise be excluded by default. Has no effect for a non-recoverable model class.

limit?​

optional limit?: number

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

The total number of resources to retrieve.

page?​

optional page?: number

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

The page number of the paginated results to retrieve.

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

skipCache?​

optional skipCache?: boolean

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

Set to true to skip retrieval from the cache. Default is false.

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:153

The desired version number of the resources to retrieve.