Skip to main content

deleteFile

talawa-apiDocs


talawa-api / REST/services/minio / deleteFile

Function: deleteFile()

> deleteFile(bucketName, objectKey): Promise<DeleteObjectCommandOutput>

Deletes a file from a specified S3 bucket.

The deleteFile function deletes an object in an S3 bucket using the DeleteObjectCommand. If an error occurs during the deletion process, it logs the error and rethrows it.

Parameters

bucketName: string

The name of the S3 bucket from which the file will be deleted.

objectKey: string

The key of the object to be deleted in the S3 bucket.

Returns

Promise<DeleteObjectCommandOutput>

A promise that resolves to the output of the DeleteObjectCommand.

Example

const response = await deleteFile("my-bucket", "image123.png");
console.log(response);

Defined in

src/REST/services/minio/index.ts:114