Use GetObjectOpts in minio.d.ts (minio#1106)

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

Hide file tree

Showing 2 changed files with 43 additions and 5 deletions.
diff --git a/src/internal/type.ts b/src/internal/type.ts
@@ -80,7 +80,7 @@ export type Lifecycle = LifecycleConfig | null | ''
 export type Lock = LockConfig | EmptyObject
 export type Retention = RetentionOptions | EmptyObject
 export type IsoDate = string
-export type GetObjectOpt = {
+export type GetObjectOpts = {
   versionId?: string
 }
 

diff --git a/src/minio.d.ts b/src/minio.d.ts
@@ -22,6 +22,7 @@ import type {
   ENCRYPTION_TYPES,
   EncryptionConfig,
   EncryptionRule,
+  GetObjectOpts,
   IncompleteUploadedBucketItem,
   InputSerialization,
   IsoDate,
@@ -49,6 +50,7 @@ import type {
   RetentionOptions,
   SelectOptions,
   SourceObjectStats,
+  StatObjectOpts,
   Tag,
   TagList,
   UploadedObjectInfo,
@@ -72,6 +74,7 @@ export type {
   ENCRYPTION_TYPES,
   EncryptionConfig,
   EncryptionRule,
+  GetObjectOpts,
   IncompleteUploadedBucketItem,
   InputSerialization,
   IsoDate,
@@ -99,6 +102,7 @@ export type {
   RetentionOptions,
   SelectOptions,
   SourceObjectStats,
+  StatObjectOpts,
   Tag,
   TagList,
   UploadedObjectInfo,
@@ -216,7 +220,13 @@ export class Client extends TypedClient {
 
   // Object operations
   getObject(bucketName: string, objectName: string, callback: ResultCallback<ReadableStream>): void
-  getObject(bucketName: string, objectName: string): Promise<ReadableStream>
+  getObject(
+    bucketName: string,
+    objectName: string,
+    getOpts: GetObjectOpts,
+    Getcallback: ResultCallback<ReadableStream>,
+  ): void
+  getObject(bucketName: string, objectName: string, getOpts?: GetObjectOpts): Promise<ReadableStream>
 
   getPartialObject(
     bucketName: string,
@@ -231,10 +241,38 @@ export class Client extends TypedClient {
     length: number,
     callback: ResultCallback<ReadableStream>,
   ): void
-  getPartialObject(bucketName: string, objectName: string, offset: number, length?: number): Promise<ReadableStream>
+  getPartialObject(
+    bucketName: string,
+    objectName: string,
+    offset: number,
+    getOpts: GetObjectOpts,
+    callback: ResultCallback<ReadableStream>,
+  ): void
+  getPartialObject(
+    bucketName: string,
+    objectName: string,
+    offset: number,
+    length: number,
+    getOpts: GetObjectOpts,
+    callback: ResultCallback<ReadableStream>,
+  ): void
+  getPartialObject(
+    bucketName: string,
+    objectName: string,
+    offset: number,
+    length?: number,
+    getOpts?: GetObjectOpts,
+  ): Promise<ReadableStream>
 
   fGetObject(bucketName: string, objectName: string, filePath: string, callback: NoResultCallback): void
-  fGetObject(bucketName: string, objectName: string, filePath: string): Promise<void>
+  fGetObject(
+    bucketName: string,
+    objectName: string,
+    filePath: string,
+    getOpts: GetObjectOpts,
+    callback: NoResultCallback,
+  ): void
+  fGetObject(bucketName: string, objectName: string, filePath: string, getOpts?: GetObjectOpts): Promise<void>
 
   putObject(
     bucketName: string,
@@ -353,7 +391,7 @@ export class Client extends TypedClient {
   getObjectTagging(
     bucketName: string,
     objectName: string,
-    getOptions: VersionIdentification,
+    getOptions: GetObjectOpts,
     callback: ResultCallback<Tag[]>,
   ): void
   getObjectTagging(bucketName: string, objectName: string, getOptions?: VersionIdentification): Promise<Tag[]>