Options
All
  • Public
  • Public/Protected
  • All
Menu

Module delete

Index

Functions

Const deleteBucket

  • deleteBucket(bucket: string): Promise<void>
  • Delete a S3 bucket

    Parameters

    • bucket: string

      AWS S3 bucket

    Returns Promise<void>

Const deleteFromKeys

  • deleteFromKeys(bucket: string, keys: string[]): Promise<void>
  • Delete all objects in the keys list from S3 bucket

    Parameters

    • bucket: string

      AWS S3 bucket where the objects are stored

    • keys: string[]

      List of object keys

    Returns Promise<void>

Const deleteFromPrefix

  • deleteFromPrefix(bucket: string, prefix: string): Promise<void>
  • Delete all objects under the given prefix from S3 bucket

    Parameters

    • bucket: string

      AWS S3 bucket where the objects are stored

    • prefix: string

      Prefix where the objects are under

    Returns Promise<void>

Const deleteObject

  • deleteObject(bucket: string, key: string): Promise<void>
  • Retrieve the list of objects from AWS S3 bucket under a given prefix and search string

    Parameters

    • bucket: string

      AWS S3 bucket where the objects are stored

    • key: string

      Key for the object that will be deleted

    Returns Promise<void>

    • List of keys inside the bucket, under the path, and filtered

Generated using TypeDoc