You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by xu...@apache.org on 2023/04/25 11:50:01 UTC

[incubator-opendal] 01/02: fix(bindings/nodejs): Fix index.d.ts not updated

This is an automated email from the ASF dual-hosted git repository.

xuanwo pushed a commit to branch fix-index-d.ts-not-updated
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git

commit ae848ce698fbb007418597a092cce2786c6075be
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Tue Apr 25 19:47:14 2023 +0800

    fix(bindings/nodejs): Fix index.d.ts not updated
    
    Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
 bindings/nodejs/index.d.ts | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/bindings/nodejs/index.d.ts b/bindings/nodejs/index.d.ts
index 1bd46945..e0b2adec 100644
--- 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 {