payload
Version:
Node, React, Headless CMS and Application Framework built on Next.js
32 lines • 1.03 kB
TypeScript
import type { CollectionSlug } from '../../index.js';
import type { PayloadRequest, Where } from '../../types/index.js';
import type { GetFolderDataResult } from '../types.js';
type Args = {
/**
* Specify to query documents from a specific collection
* @default undefined
* @example 'posts'
*/
collectionSlug?: CollectionSlug;
/**
* Optional where clause to filter documents by
* @default undefined
*/
documentWhere?: Where;
/**
* The ID of the folder to query documents from
* @default undefined
*/
folderID?: number | string;
/** Optional where clause to filter subfolders by
* @default undefined
*/
folderWhere?: Where;
req: PayloadRequest;
};
/**
* Query for documents, subfolders and breadcrumbs for a given folder
*/
export declare const getFolderData: ({ collectionSlug, documentWhere, folderID: _folderID, folderWhere, req, }: Args) => Promise<GetFolderDataResult>;
export {};
//# sourceMappingURL=getFolderData.d.ts.map