findServer

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

Pass paginationOpts: { ..., totalDocs: true } to also count matching documents on the first page (cursor: null) only. Counts with take(countLimit + 1) instead of .collect()-ing the whole matching set (Design Decision 35, default countLimit 10000) — totalDocs is the exact count up to that cap, never null; totalDocsCapped: true means more matching documents exist beyond the cap and totalDocs equals countLimit, a floor rather than an exact count.

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 a first-page count
const result = await find({
  ctx,
  collection: "posts",
  paginationOpts: { numItems: 100, cursor: null, totalDocs: true },
});
// result: { page: [...], continueCursor: "...", isDone: false, totalDocs: 1523, totalDocsCapped: false }

Call Signature

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

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

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>[]>