[docs][xs]: Add documentation for pushBlob() function - #4

lib/index.js

@@ -27,12 +27,12 @@ class Client {
     let scope = [`obj:${this.organizationId}/${this.datasetId}/*:write`]
 
     // Get the JWT token from CkanAuthz, the user should provide the url
-      const response = await CkanAuthApi.getJWTFromCkanAuthz(
-        this.api,
-        this.apiKey,
-        scope
-      )
-      return response.result.token
+    const response = await CkanAuthApi.getJWTFromCkanAuthz(
+      this.api,
+      this.apiKey,
+      scope
+    )
+    return response.result.token
   }
 
   /**
@@ -94,8 +94,18 @@ class Client {
   }
 
   /**
-   * @param {File} file
+   * The result of push blob method
+   * @typedef {Object} PushBlobResult
+   * @property {string} oid - oid
+   * @property {number} size - size of the file
+   * @property {string} name - resource name
+   * @property {boolean} success - Indicates whether the request was successful or not
+   * @property {boolean} fileExists - Indicates whether the resource exists or not
+   */
+  /**
+   * @param {Object} resource - This datajs resource. Please check https://github.com/datopian/data.js
    * @param {function} onProgress a callback function to track the progress
+   * @return {Promise<PushBlobResult>} request result
    */
   async pushBlob(resource, onProgress) {
     // Get the JWT token
@@ -128,7 +138,11 @@ class Client {
         resourceContent,
         onProgress
       )
-      await CkanUploadAPI.verifyUpload(lfs.objects[0].actions.verify, resource.hash, resource.size)
+      await CkanUploadAPI.verifyUpload(
+        lfs.objects[0].actions.verify,
+        resource.hash,
+        resource.size
+      )
       return result
     } else {
       // File is already in storage