Files
payload/examples/db-example/src/deleteVersions.ts
Dan Ribbens f07783a279 chore: move db-example to examples (#6532)
- Moved to examples
- Removed unnecessary dependencies
- Improved the readme with instructions for writing the db adapter
2024-05-28 10:28:18 -04:00

30 lines
1.2 KiB
TypeScript

/* eslint-disable @typescript-eslint/no-unused-vars */
import type { DeleteVersions } from 'payload/database'
import type { PayloadRequest, Where } from 'payload/types'
import type { ExampleAdapter } from '.'
/**
* Deletes many version documents from your database.
*
* @param {ExampleAdapter} this - The ExampleAdapter instance.
* @param {string} collection - The name of the collection to reference for deleting versions.
* @param {string} locale - The locale being used - can be one locale or "all" (locale="all").
* @param {PayloadRequest} req - The Express request object containing the currently authenticated user.
* @param {Where} where - The specific query used to find the documents for deleting versions.
* @returns {Promise<void>} A promise that resolves with the created global document.
*/
export const deleteVersions: DeleteVersions = async function deleteVersions(
this: ExampleAdapter,
{ collection, locale, req = {} as PayloadRequest, where },
) {
/**
* Implement the logic to delete many version documents from your database.
*
* @example
* ```ts
* await adapterSpecificVersionsModel.deleteMany(query, options)
* ```
*/
}