chore(core-flows,types,utils): fixes to TSDocs (#12692)

This commit is contained in:
Shahed Nasser
2025-06-10 18:33:41 +03:00
committed by GitHub
parent d8b196d6b1
commit 5ba842bfb0
4 changed files with 15 additions and 9 deletions

View File

@@ -128,18 +128,23 @@ export class AbstractFileProviderService implements IFileProvider {
* This method deletes one or more files from the storage. It's used when an admin user
* deletes a product image, or other custom file deletions.
*
* @param {FileTypes.ProviderDeleteFileDTO | FileTypes.ProviderDeleteFileDTO[]} files - The details of the file(s) to delete.
* @returns {Promise<void>} Resolves when the file is deleted.
* @param {FileTypes.ProviderDeleteFileDTO | FileTypes.ProviderDeleteFileDTO[]} files - The details of the files to delete.
* @returns {Promise<void>} Resolves when the files are deleted.
*
* @example
* class MyFileProviderService extends AbstractFileProviderService {
* // ...
* async delete(file: ProviderDeleteFileDTO): Promise<void> {
* async delete(
* files: FileTypes.ProviderDeleteFileDTO | FileTypes.ProviderDeleteFileDTO[]
* ): Promise<void> {
* // TODO logic to remove the file from storage
* // Use the `file.fileKey` to delete the file, which is the identifier of the file
* // in the provider's storage.
* // for example:
* this.client.delete(file.fileKey)
* const fileArray = Array.isArray(files) ? files : [files]
* for (const file of fileArray) {
* this.client.delete(file.fileKey)
* }
* }
* }
*/