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
33 lines
1.0 KiB
Plaintext
33 lines
1.0 KiB
Plaintext
import type { CollectionSlug } from '../../index.js';
|
|
import type { PayloadRequest, Where } from '../../types/index.js';
|
|
import type { FolderSortKeys, 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;
|
|
sort: FolderSortKeys;
|
|
};
|
|
/**
|
|
* Query for documents, subfolders and breadcrumbs for a given folder
|
|
*/
|
|
export declare const getFolderData: ({ collectionSlug, documentWhere, folderID: _folderID, folderWhere, req, sort, }: Args) => Promise<GetFolderDataResult>;
|
|
export {};
|
|
//# sourceMappingURL=getFolderData.d.ts.map |