@olympeio/runtime-node 9.9.0 → 9.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olympeio/runtime-node",
-  "version": "9.9.0",
+  "version": "9.9.1",
   "description": "Olympe Node Runtime Environment",
   "types": "types/index.d.ts",
   "dependencies": {

package/types/cloud.d.ts

@@ -169,28 +169,58 @@ export class File extends CloudObject {
     static createFromURL(transaction: Transaction, name: string, url: string, mimeType?: string, source?: Source, tag?: string): string;
 
     /**
-     * Retrieve content from this file asynchronously
+     * Gets the file content as an ArrayBuffer.
      *
-     * @param onSuccess callback to execute when byte content has been retrieved successfully
-     * @param onFailure callback to execute when content retrieval has failed
+     * @deprecated consider using the new `getContentAsBinary` method returning a Promise instead
+     * @param onSuccess (deprecated) callback to execute when byte content has been retrieved successfully
+     * @param onFailure (deprecated) callback to execute when content retrieval has failed
      */
-    getContentAsBinary(onSuccess: (content: ArrayBuffer) => void, onFailure?: (errMsg: string) => void): void;
+    getContentAsBinary(onSuccess: (content: ArrayBuffer) => void, onFailure?: (errMsg: string) => void);
 
     /**
-     * Retrieve string content from this file asynchronously
+     * Gets the file content as an ArrayBuffer.
      *
-     * @param onSuccess callback to execute when string content has been retrieved successfully
-     * @param onFailure callback to execute when content retrieval has failed
+     * @return promise resolving with the content as a byte array
      */
-    getContentAsString(onSuccess: (content: string) => void, onFailure?: (errMsg: string) => void): void;
+    getContentAsBinary():Promise<ArrayBuffer>;
 
     /**
-     * Retrieve string content from URL asynchronously
+     * Get the content of this file and returns it as an UTF-8 string.
+     * **Note:** this method should be used only when the file is a text file.
      *
-     * @param onSuccess callback to execute when content has been retrieved successfully
-     * @param onFailure callback to execute when content retrieval has failed
+     * @deprecated consider using the new `getContentAsString` method returning a Promise instead
+     * @param onSuccess (deprecated) callback to execute when string content has been retrieved successfully
+     * @param onFailure (deprecated) callback to execute when content retrieval has failed
      */
-    getContentUrl(onSuccess: (content: string) => void, onFailure?: () => void): void;
+    getContentAsString(onSuccess: (content: string) => void, onFailure?: (errMsg: string) => void);
+
+    /**
+     * Get the content of this file and returns it as an UTF-8 string.
+     * **Note:** this method should be used only when the file is a text file.
+     *
+     * @return promise resolving with the content as a string
+     */
+    getContentAsString(): Promise<string>;
+
+    /**
+     * Gets the URL that gives direct access to the file content:
+     * - For files that are external to Olympe, gives the normal URL
+     * - For the files stored by Olympe, provides a dataURL, with the content embedded in Base64
+     *
+     * @deprecated consider using the new `getContentUrl` method returning a Promise instead
+     * @param onSuccess (deprecated) callback to execute when content has been retrieved successfully
+     * @param onFailure (deprecated) callback to execute when content retrieval has failed
+     */
+    getContentUrl(onSuccess: (content: string) => void, onFailure?: () => void);
+
+    /**
+     * Gets the URL that gives direct access to the file content:
+     * - For files that are external to Olympe, gives the normal URL
+     * - For the files stored by Olympe, provides a dataURL, with the content embedded in Base64
+     *
+     * @return promise resolving with the content as a string
+     */
+    getContentUrl(): Promise<string>;
 
     /**
      * Save this file with specified name