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
67 lines
3.5 KiB
Plaintext
67 lines
3.5 KiB
Plaintext
import type { FindOptions } from '../../../collections/operations/local/find.js';
|
|
import type { GlobalSlug, Payload, RequestContext, TypedFallbackLocale, TypedLocale } from '../../../index.js';
|
|
import type { Document, PayloadRequest, PopulateType, SelectType, TransformGlobalWithSelect } from '../../../types/index.js';
|
|
import type { DraftFlagFromGlobalSlug, SelectFromGlobalSlug } from '../../config/types.js';
|
|
import { type GlobalFindOneArgs } from '../findOne.js';
|
|
type BaseFindOneOptions<TSlug extends GlobalSlug, TSelect extends SelectType> = {
|
|
/**
|
|
* [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;
|
|
/**
|
|
* You may pass the document data directly which will skip the `db.findOne` database query.
|
|
* This is useful if you want to use this endpoint solely for running hooks and populating data.
|
|
*/
|
|
data?: Record<string, unknown>;
|
|
/**
|
|
* [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
|
|
*/
|
|
depth?: number;
|
|
/**
|
|
* Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
|
|
*/
|
|
fallbackLocale?: TypedFallbackLocale;
|
|
/**
|
|
* Include info about the lock status to the result with fields: `_isLocked` and `_userEditing`
|
|
*/
|
|
includeLockStatus?: boolean;
|
|
/**
|
|
* Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
|
|
*/
|
|
locale?: 'all' | 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;
|
|
/**
|
|
* Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
|
|
*/
|
|
populate?: PopulateType;
|
|
/**
|
|
* 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>;
|
|
/**
|
|
* Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config.
|
|
* @default false
|
|
*/
|
|
showHiddenFields?: boolean;
|
|
/**
|
|
* the Global slug to operate against.
|
|
*/
|
|
slug: TSlug;
|
|
/**
|
|
* If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.
|
|
*/
|
|
user?: Document;
|
|
} & Pick<FindOptions<string, SelectType>, 'select'> & Pick<GlobalFindOneArgs, 'flattenLocales'>;
|
|
export type Options<TSlug extends GlobalSlug, TSelect extends SelectType> = BaseFindOneOptions<TSlug, TSelect> & DraftFlagFromGlobalSlug<TSlug>;
|
|
export declare function findOneGlobalLocal<TSlug extends GlobalSlug, TSelect extends SelectFromGlobalSlug<TSlug>>(payload: Payload, options: Options<TSlug, TSelect>): Promise<TransformGlobalWithSelect<TSlug, TSelect>>;
|
|
export {};
|
|
//# sourceMappingURL=findOne.d.ts.map |