Interface: RepoFindOptions

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

The available options used for RepoUtils operations.

Extends

• RepoOperationOptions

Properties

action?

optional action?: string

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

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

Set to true to ignore the ACL permissions check.

Inherited from

RepoOperationOptions.ignoreACL

---

limit?

optional limit?: number

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

The total number of resources to retrieve.

---

page?

optional page?: number

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

The page number of the paginated results to retrieve.

---

pushChannels?

optional pushChannels?: string[]

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

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

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

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

---

skipPush?

optional skipPush?: boolean

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

Set to true to not send a push notification.

Inherited from

RepoOperationOptions.skipPush

---

user?

optional user?: JWTUser

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

The authenticated user making the request.

Inherited from

RepoOperationOptions.user

---

version?

optional version?: string | number

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

The desired version number of the resources to retrieve.