16 lines
702 B
TypeScript
16 lines
702 B
TypeScript
import type { BasePayload } from 'payload';
|
|
import type { GlobalQueryOptions } from './getGlobal.js';
|
|
/** Slug of the SiteSettings global defined by the plugin. */
|
|
export declare const SITE_SETTINGS_SLUG = "site-settings";
|
|
/**
|
|
* Fetches the SiteSettings global.
|
|
*
|
|
* Generic over the return type so the client can pass their generated
|
|
* `SiteSetting` type for full type safety, while still working without it.
|
|
*
|
|
* @example
|
|
* import type { SiteSetting } from '@/payload-types'
|
|
* const settings = await getSiteSettings<SiteSetting>(payload, { locale: 'pl' })
|
|
*/
|
|
export declare function getSiteSettings<T = Record<string, unknown>>(payload: BasePayload, options?: GlobalQueryOptions): Promise<T>;
|