Merge pull request #1123 from remotestorage/docs/correct_return_storefile

galfert · web-flow · commit 1456df0d35cd · 2018-04-06T10:48:47.000+02:00
Fix return value for storeFile doc
diff --git a/src/baseclient.js b/src/baseclient.js
@@ -167,7 +167,7 @@ BaseClient.prototype = {
    * @param {string} path     - Path relative to the module root
    * @param {string|ArrayBuffer|ArrayBufferView} body - Raw data to store
    *
-   * @returns {Promise} A promise for an object
+   * @returns {Promise} A promise for the created/updated revision (ETag)
    */
   storeFile: function (mimeType, path, body) {
     if (typeof(mimeType) !== 'string') {

Original file line number	Diff line number	Diff line change
`@@ -167,7 +167,7 @@ BaseClient.prototype = {`
`167`	`167`	`* @param {string} path - Path relative to the module root`
`168`	`168`	`* @param {string\|ArrayBuffer\|ArrayBufferView} body - Raw data to store`
`169`	`169`	`*`
`170`		`- * @returns {Promise} A promise for an object`
	`170`	`+ * @returns {Promise} A promise for the created/updated revision (ETag)`
`171`	`171`	`*/`
`172`	`172`	`storeFile: function (mimeType, path, body) {`
`173`	`173`	`if (typeof(mimeType) !== 'string') {`