Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
55 lines
2.5 KiB
Plaintext
55 lines
2.5 KiB
Plaintext
import type { CollectionSlug, Payload, RequestContext, TypedLocale } from '../../../index.js';
|
|
import type { Document, PayloadRequest, Where } from '../../../types/index.js';
|
|
export type CountOptions<TSlug extends CollectionSlug> = {
|
|
/**
|
|
* the Collection slug to operate against.
|
|
*/
|
|
collection: TSlug;
|
|
/**
|
|
* [Context](https://payloadcms.com/docs/hooks/context), which will then be passed to `context` and `req.context`,
|
|
* which can be read by hooks. Useful if you want to pass additional information to the hooks which
|
|
* shouldn't be necessarily part of the document, for example a `triggerBeforeChange` option which can be read by the BeforeChange hook
|
|
* to determine if it should run or not.
|
|
*/
|
|
context?: RequestContext;
|
|
/**
|
|
* When set to `true`, errors will not be thrown.
|
|
*/
|
|
disableErrors?: boolean;
|
|
/**
|
|
* Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
|
|
*/
|
|
locale?: TypedLocale;
|
|
/**
|
|
* Skip access control.
|
|
* Set to `false` if you want to respect Access Control for the operation, for example when fetching data for the front-end.
|
|
* @default true
|
|
*/
|
|
overrideAccess?: boolean;
|
|
/**
|
|
* The `PayloadRequest` object. You can pass it to thread the current [transaction](https://payloadcms.com/docs/database/transactions), user and locale to the operation.
|
|
* Recommended to pass when using the Local API from hooks, as usually you want to execute the operation within the current transaction.
|
|
*/
|
|
req?: Partial<PayloadRequest>;
|
|
/**
|
|
* When set to `true`, the query will include both normal and trashed documents.
|
|
* To query only trashed documents, pass `trash: true` and combine with a `where` clause filtering by `deletedAt`.
|
|
* By default (`false`), the query will only include normal documents and exclude those with a `deletedAt` field.
|
|
*
|
|
* This argument has no effect unless `trash` is enabled on the collection.
|
|
* @default false
|
|
*/
|
|
trash?: boolean;
|
|
/**
|
|
* If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.
|
|
*/
|
|
user?: Document;
|
|
/**
|
|
* A filter [query](https://payloadcms.com/docs/queries/overview)
|
|
*/
|
|
where?: Where;
|
|
};
|
|
export declare function countLocal<TSlug extends CollectionSlug>(payload: Payload, options: CountOptions<TSlug>): Promise<{
|
|
totalDocs: number;
|
|
}>;
|
|
//# sourceMappingURL=count.d.ts.map |