Interface: GetDocListArgs<T, F>

Defined in: packages/client/src/modules/db/types.ts:28

Remarks

Pagination is always explicit. limit defaults to 20 if omitted — no method in this module ever fetches an unbounded collection silently.

Type Parameters

T

T = FrappeDoc<object>

F

F extends FieldsArg<T> = "*"

Properties

asDict?

optional asDict?: true

Defined in: packages/client/src/modules/db/types.ts:40

Object-shaped rows are required by this typed API. Defaults to true.

---

debug?

optional debug?: boolean

Defined in: packages/client/src/modules/db/types.ts:38

---

expand?

optional expand?: string[]

Defined in: packages/client/src/modules/db/types.ts:42

---

fields?

optional fields?: F

Defined in: packages/client/src/modules/db/types.ts:29

---

filters?

optional filters?: Filter<T>[]

Defined in: packages/client/src/modules/db/types.ts:30

---

groupBy?

optional groupBy?: string & Record<never, never> | keyof T

Defined in: packages/client/src/modules/db/types.ts:31

---

limit?

optional limit?: number

Defined in: packages/client/src/modules/db/types.ts:36

Number of documents to fetch. Defaults to 20. There is no "fetch all" option — use db.paginate().

---

orderBy?

optional orderBy?: object

Defined in: packages/client/src/modules/db/types.ts:32

field

field: string & Record<never, never> | keyof T

order?

optional order?: "asc" | "desc"

---

orFilters?

optional orFilters?: Filter<T>[]

Defined in: packages/client/src/modules/db/types.ts:41

---

parent?

optional parent?: string

Defined in: packages/client/src/modules/db/types.ts:37

---

start?

optional start?: number

Defined in: packages/client/src/modules/db/types.ts:34

Fetch from nth document in the filtered/sorted list.