ListOptions

Defined in: packages/repo/src/types.ts:420

Options for Repository.list.

Properties

contextValues?

optional contextValues?: ContextValues

Defined in: packages/repo/src/types.ts:459

Advanced: reuse an existing context bag for a nested repository call. When omitted, the repository creates a fresh bag for this operation.

---

orderBy?

optional orderBy?: string

Defined in: packages/repo/src/types.ts:438

An AIP-132 order_by string (e.g. "age desc, display_name"). Fields are validated against the proto schema.

---

pageSize?

optional pageSize?: number

Defined in: packages/repo/src/types.ts:425

Maximum number of results to return per page. Clamped to the repository’s maxSize. Defaults to defaultSize.

---

pageToken?

optional pageToken?: PageToken

Defined in: packages/repo/src/types.ts:432

A PageToken for offset-based pagination. Obtain this by calling parse() from @protoutil/aip/pagination on the raw page token string from the client request.

---

readMask?

optional readMask?: FieldMask

Defined in: packages/repo/src/types.ts:450

A FieldMask controlling which fields are returned. Overrides the repository’s default read mask. Defaults to "*".

---

showTotalSize?

optional showTotalSize?: boolean

Defined in: packages/repo/src/types.ts:444

When true, the result includes a totalSize field with the total number of matching resources (before pagination).

---

transaction?

optional transaction?: Engine

Defined in: packages/repo/src/types.ts:453

Run the operation within a transaction.