16 lines
808 B
TypeScript
16 lines
808 B
TypeScript
import type { BasePayload } from 'payload';
|
|
/** Locale argument accepted by the global helpers. */
|
|
export type GlobalQueryOptions = {
|
|
/** Relationship population depth. Defaults to Payload's config default. */
|
|
depth?: number;
|
|
/** Locale to fetch, or 'all' for every locale's values. Defaults to Payload's default. */
|
|
locale?: string;
|
|
};
|
|
/**
|
|
* Thin wrapper over payload.findGlobal that keeps locale/depth handling in one
|
|
* place. The plugin never calls getPayload itself — the caller passes the
|
|
* instance (from getPayload in their app, or req.payload in a hook), matching
|
|
* the plugin's data-access rule: logic here, instance from outside.
|
|
*/
|
|
export declare function getGlobal<T = Record<string, unknown>>(payload: BasePayload, slug: string, options?: GlobalQueryOptions): Promise<T>;
|