Introduce S3ListObject and use it (minio#1106)

fflorent · Jul 18, 2023 · 54a1ca2 · 54a1ca2
1 parent 73d8027
commit 54a1ca2
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/src/internal/type.ts b/src/internal/type.ts
@@ -105,6 +105,18 @@ export type BucketItemWithMetadata = BucketItem & {
   metadata?: ItemBucketMetadata | ItemBucketMetadataList
 }
 
+export type S3ListObject =
+  | { prefix: string; size: number }
+  | { name: string; size: number } // sometime api return this, not sure if it's valid
+  | {
+      name: string
+      lastModified: Date
+      etag: string
+      size: number
+      isDeleteMarker?: boolean
+      isLatest?: boolean
+    }
+
 export type StatObjectOpts = {
   versionId?: string
 }

diff --git a/src/minio.d.ts b/src/minio.d.ts
@@ -48,6 +48,7 @@ import type {
   RETENTION_MODES,
   RETENTION_VALIDITY_UNITS,
   RetentionOptions,
+  S3ListObject,
   SelectOptions,
   SourceObjectStats,
   StatObjectOpts,
@@ -100,6 +101,7 @@ export type {
   RETENTION_MODES,
   RETENTION_VALIDITY_UNITS,
   RetentionOptions,
+  S3ListObject,
   SelectOptions,
   SourceObjectStats,
   StatObjectOpts,
@@ -162,9 +164,14 @@ export class Client extends TypedClient {
   bucketExists(bucketName: string, callback: ResultCallback<boolean>): void
   bucketExists(bucketName: string): Promise<boolean>
 
-  listObjects(bucketName: string, prefix?: string, recursive?: boolean): BucketStream<BucketItem>
+  listObjects(bucketName: string, prefix?: string, recursive?: boolean): BucketStream<S3ListObject>
 
-  listObjectsV2(bucketName: string, prefix?: string, recursive?: boolean, startAfter?: string): BucketStream<BucketItem>
+  listObjectsV2(
+    bucketName: string,
+    prefix?: string,
+    recursive?: boolean,
+    startAfter?: string,
+  ): BucketStream<S3ListObject>
 
   listIncompleteUploads(
     bucketName: string,