Options
All
  • Public
  • Public/Protected
  • All
Menu

Module list

Index

Functions

Functions

Const listObjects

  • listObjects(bucket: string, prefix?: string, searchPath?: string, maxKeys?: number): Promise<string[]>
  • 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

    • prefix: string = ""

      Prefix where the objects are under

    • searchPath: string = ".*"

      Basic search string to filter out keys on result (uses Javascript regex)

    • maxKeys: number = 100

      Max number of keys to have pagination

    Returns Promise<string[]>

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

Generated using TypeDoc