findServer

Find documents in a collection with optional pagination and total count.

When includeTotalCount=true, runs .collect() on the first page to count all matching documents. Returns null if count exceeds 32k documents.

Param

args

Find arguments including filters, sort, pagination, and count options

Example

// Without pagination
const docs = await find({ ctx, collection: "posts" });

// With pagination
const result = await find({
  ctx,
  collection: "posts",
  paginationOpts: { numItems: 100, cursor: null },
});
// result: { page: [...], continueCursor: "...", isDone: false }

// With pagination and count (first page only)
const result = await find({
  ctx,
  collection: "posts",
  paginationOpts: { numItems: 100, cursor: null },
  includeTotalCount: true,
});
// result: { page: [...], continueCursor: "...", isDone: false, totalCount: 1523 }

Call Signature

findServer<DataModel, TCollectionSlug, TPopulate, D>(args): Promise<DocReturnItem<TCollectionSlug, TPopulate, D>[]>

Defined in: packages/core/src/api/find/server.ts:131

Type Parameters

DataModel

DataModel extends GenericDataModel

TCollectionSlug

TCollectionSlug extends string

TPopulate

TPopulate extends PopulateShape<TCollectionSlug> = Record<string, never>

D

D extends number = 0

Parameters

args

FindServerArgs<DataModel, TCollectionSlug, TPopulate, D> & object

Returns

Promise<DocReturnItem<TCollectionSlug, TPopulate, D>[]>