QueryParams<T>

@blobs/sdk v0.1.0

---

@blobs/sdk / utils/types / QueryParams

QueryParams<T> = object

Defined in: utils/types.ts:53

Generic typed query-builder shape.

sort accepts bare keys for ascending or -key strings for descending.

Type Parameters

T

T

The entity being queried.

Properties

filter?

optional filter?: Partial<T>

Defined in: utils/types.ts:55

Subset of fields to filter on (exact match).

---

sort?

optional sort?: (keyof T | `-${string & keyof T}`)[]

Defined in: utils/types.ts:57

Sort fields; prefix with - for descending order (e.g., -created_at).

---

limit?

optional limit?: number

Defined in: utils/types.ts:59

Maximum number of records to return.

---

offset?

optional offset?: number

Defined in: utils/types.ts:61

Number of records to skip (pagination).

---

include?

optional include?: keyof T[]

Defined in: utils/types.ts:63

Related fields to eager-load with each record.