fix(bindings/nodejs): Fix index.d.ts not updated (#2117)

* fix(bindings/nodejs): Fix index.d.ts not updated Signed-off-by: Xuanwo <github@xuanwo.io> * Make add check Signed-off-by: Xuanwo <github@xuanwo.io> --------- Signed-off-by: Xuanwo <github@xuanwo.io>
apache · Apr 25, 2023 · d6ce049 · d6ce049
1 parent 88915b9
commit d6ce049
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 7 deletions.
diff --git a/.github/workflows/bindings_nodejs.yml b/.github/workflows/bindings_nodejs.yml
@@ -70,6 +70,10 @@ jobs:
 
       - name: Build
         run: yarn build:debug
+
+      - name: Check diff
+        run: git diff --exit-code
+
       - name: Test bindings
         run: yarn test
 

diff --git a/bindings/nodejs/index.d.ts b/bindings/nodejs/index.d.ts
@@ -336,14 +336,14 @@ export class Operator {
    * ### Example
    *
    * ```javascript
-   * const req = op.presignRead(path, parseInt(expires));
+   * const req = await op.presignRead(path, parseInt(expires));
    *
    * console.log("method: ", req.method);
    * console.log("url: ", req.url);
    * console.log("headers: ", req.headers);
    * ```
    */
-  presignRead(path: string, expires: number): PresignedRequest
+  presignRead(path: string, expires: number): Promise<PresignedRequest>
   /**
    * Get a presigned request for write.
    *
@@ -352,14 +352,14 @@ export class Operator {
    * ### Example
    *
    * ```javascript
-   * const req = op.presignWrite(path, parseInt(expires));
+   * const req = await op.presignWrite(path, parseInt(expires));
    *
    * console.log("method: ", req.method);
    * console.log("url: ", req.url);
    * console.log("headers: ", req.headers);
    * ```
    */
-  presignWrite(path: string, expires: number): PresignedRequest
+  presignWrite(path: string, expires: number): Promise<PresignedRequest>
   /**
    * Get a presigned request for stat.
    *
@@ -368,14 +368,14 @@ export class Operator {
    * ### Example
    *
    * ```javascript
-   * const req = op.presignStat(path, parseInt(expires));
+   * const req = await op.presignStat(path, parseInt(expires));
    *
    * console.log("method: ", req.method);
    * console.log("url: ", req.url);
    * console.log("headers: ", req.headers);
    * ```
    */
-  presignStat(path: string, expires: number): PresignedRequest
+  presignStat(path: string, expires: number): Promise<PresignedRequest>
 }
 export class Entry {
   /** Return the path of this entry. */
@@ -396,7 +396,11 @@ export class Metadata {
   get contentType(): string | null
   /** ETag of this object. */
   get etag(): string | null
-  /** Last Modified of this object.(UTC) */
+  /**
+   * Last Modified of this object.
+   *
+   * We will output this time in RFC3339 format like `1996-12-19T16:39:57+08:00`.
+   */
   get lastModified(): string | null
 }
 export class Lister {