extensions.d.ts 1.0 KB

123456789101112131415161718
  1. import type { TypedClient } from "./client.js";
  2. import type { BucketItemWithMetadata, BucketStream } from "./type.js";
  3. export declare class Extensions {
  4. private readonly client;
  5. constructor(client: TypedClient);
  6. /**
  7. * List the objects in the bucket using S3 ListObjects V2 With Metadata
  8. *
  9. * @param bucketName - name of the bucket
  10. * @param prefix - the prefix of the objects that should be listed (optional, default `''`)
  11. * @param recursive - `true` indicates recursive style listing and `false` indicates directory style listing delimited by '/'. (optional, default `false`)
  12. * @param startAfter - Specifies the key to start after when listing objects in a bucket. (optional, default `''`)
  13. * @returns stream emitting the objects in the bucket, the object is of the format:
  14. */
  15. listObjectsV2WithMetadata(bucketName: string, prefix?: string, recursive?: boolean, startAfter?: string): BucketStream<BucketItemWithMetadata>;
  16. private listObjectsV2WithMetadataGen;
  17. private listObjectsV2WithMetadataQuery;
  18. }