f07783a279
- Moved to examples - Removed unnecessary dependencies - Improved the readme with instructions for writing the db adapter
47 lines
1.9 KiB
TypeScript
47 lines
1.9 KiB
TypeScript
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
import type { PaginatedDocs, QueryDrafts } from 'payload/database'
|
|
import type { PayloadRequest, Where } from 'payload/types'
|
|
|
|
import type { ExampleAdapter } from '.'
|
|
|
|
/**
|
|
* Queries for drafts in the specified collection based on the provided criteria using
|
|
* the incoming where, sort, page query and then only returns the correct drafts in the format Payload expects.
|
|
*
|
|
* @param {ExampleAdapter} this - The ExampleAdapter instance.
|
|
* @param {string} collection - The name of the collection to reference for querying drafts.
|
|
* @param {number} limit - The maximum number of drafts to return.
|
|
* @param {string} locale - The locale being used - can be one locale or "all" (locale="all").
|
|
* @param {number} page - The page number of the results to return.
|
|
* @param {boolean} pagination - Determines whether pagination is enabled.
|
|
* @param {PayloadRequest} req - The Express request object containing the currently authenticated user.
|
|
* @param {string} sort - The top-level field to sort the results by.
|
|
* @param {Where} where - The specific query used to filter drafts.
|
|
* @returns {Promise<PaginatedDocs<T>>} A promise resolving to the paginated drafts matching the query criteria.
|
|
*/
|
|
export const queryDrafts: QueryDrafts = async function queryDrafts(
|
|
this: ExampleAdapter,
|
|
{ collection, limit, locale, page, pagination, req = {} as PayloadRequest, sort: sortArg, where },
|
|
) {
|
|
let result
|
|
/**
|
|
* Implement the logic to paginate the query results according to your database's methods.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const result = await adapterSpecificModel.paginate(versionQuery, paginationOptions)
|
|
* ```
|
|
*/
|
|
|
|
/**
|
|
* This should be the shape of the data that gets returned in Payload when you do:
|
|
*
|
|
* ?depth=0&locale=all&fallbackLocale=null
|
|
*
|
|
* The result of the outgoing data is always going to be the same shape that Payload expects
|
|
*
|
|
*/
|
|
|
|
return result
|
|
}
|