Updated a Reference doc

Author: rohitmishra209

js-sdk-reference.zip

@@ -1,6 +1,6 @@
 {
   "name": "contentstack",
-  "version": "3.5.0",
+  "version": "3.5.1",
   "description": "Contentstack Javascript SDK",
   "homepage": "https://www.contentstack.com/",
   "author": {

package.json

@@ -24,16 +24,16 @@ class Contentstack {
 
 	/**
 	 * @method Stack
-	 * @description Initialize "Contentstack" Stack javascript-SDK instance
+	 * @description Initialize an instance of ‘Stack’
 	 * @api public
 	 * @example
-	 * var Stack = Contentstack.Stack('api_key', 'access_token', 'environment');
-	 *                  OR
-	 * var Stack = Contentstack.Stack({
-	 *      'api_key':'bltsomethingapikey',
-	 *      'access_token':'bltsomethongtoken',
-	 *      'environment':'environment_name'
-	 *   });
+	 *var Stack = Contentstack.Stack('api_key', 'delivery_token', 'environment');
+                 OR
+	 *var Stack = Contentstack.Stack({
+	 *    'api_key':'stack_api_key',
+	 *   'access_token':'stack_delivery_token',
+	 *    'environment':'environment_name'
+	 * });
 	 *
 	 * @returns {Stack}
 	 */

src/core/contentstack.js

@@ -3,7 +3,7 @@ import Stack from '../stack';
 import Query from './query';
 
 /**
- * @summary Creates an instance of `Assets`.
+ * @summary Creates an instance of 'Assets'.
  * @description An initializer is responsible for creating Asset object.
  * @param {String} uid - uid of the asset
  * @example
@@ -13,55 +13,18 @@ import Query from './query';
  */
 export default class Assets {
     constructor() {
-         this._query = {};
-        /**
-         * @method only
-         * @description This method is use to show the selected fields of the assets in resultset.
-         * @param {String} [key=BASE] - single field in asset
-         * @param {Array} values - array of fields to be show in resultset
-         * @example
-         * <caption> .only with field uid </caption>
-         * Assets().only('title')
-         * @example
-         * <caption> .only with field uid </caption>
-         * Assets().only('BASE','title')
-         * @example
-         * <caption> .only with field uids(array) </caption>
-         * Assets().only(['title','description'])
-         * @returns {Asset}
-         */
+        this._query = {};        
         this.only = Utils.transform('only');
         return this;
     }
 
-    /**
-     * @method toJSON
-     * @description Converts your response into plain JavasScript object.
-     * @example
-     * assetQuery
-     *      .toJSON()
-     *      .then(function (result) {
-     *          let value = result.get(field_uid)
-     *       },function (error) {
-     *          // error function
-     *      })
-     * @returns {Object}
-     */
+    
     toJSON() {
         this.tojson = true;
         return this;
     }
 
-    /**
-     * @method AddParam
-     * @description Includes query parameters in your query.
-     * @example var data = blogQuery.addParam('include_count', 'true').toJSON().fetch()
-     *      data.then(function (result) {
-     *          // result contents count in JSON object form
-     *       },function (error) {
-     *          // error function
-     *      })
-     */
+
     addParam(key, value) {
         if (key && typeof key === 'string' && value && typeof value === 'string') {        
             this._query[key] = value;
@@ -71,12 +34,8 @@ export default class Assets {
         }
     }
 
-    /**
-     * @method fetch
-     * @description Fetches a particular Asset based on the provided assets UID.
-     * @example
-     * Stack.Assets('bltsomething123').toJSON().fetch()
-     */
+   
+
     fetch() {
         if (this.asset_uid) {
             this.requestParams = {

src/core/modules/assets.js

@@ -15,9 +15,12 @@ export default class Entry {
         this._query = {};
         /**
          * @method only
-         * @description Displays values of only the specified fields in the response
-         * @param {String} [key=BASE] - BASE (default value) - retrieves default fields of the schema.
-                                      - referenced content-type-uid - retrieves fields of the referred content type.
+         * @description Displays values of only the specified fields of entries or assets in the response
+         * @param {String} [key=BASE] -  Assets: </br>
+         *                                <p>Retrieves specified field of asset</p>
+         * @param {String}            -  Entries:</br>
+         *                                       <p>- retrieves default fields of the schema.</p>
+         *                                       <p>- referenced_content-type-uid : retrieves fields of the referred content type.</p>
          * @param {Array} values - array of fields that you want to display in the response
          * @example
          * <caption> .only with field uid </caption>
@@ -35,11 +38,12 @@ export default class Entry {
          * <caption> .only with reference_field_uid and field uids(array) </caption>
          * blogEntry.includeReference('category').only('category', ['title', 'description'])
          * @returns {Entry}
+         * @returns {Asset}
          */
         this.only = Utils.transform('only');
         /**
          * @method except
-         * @description Displays all data of an entry excluding the data of the specified fields.
+         * @description Displays all data of an entries or assets excluding the data of the specified fields.
          * @param {String} [key=BASE] - BASE (default value) - retrieves default fields of the schema.
                                                              - referenced_content-type-uid - retrieves fields of the referred content type.
          * @param {Array} values - array of fields that you want to skip in the response
@@ -134,7 +138,7 @@ export default class Entry {
 
      /**
      * @method addQuery
-     * @description Adds query to Entry object.
+     * @description Adds query to Entry object
      * @param {String} key - key of the query
      * @param {String} value - value of the query
      * @example blogEntry.addQuery('include_schema',true)
@@ -150,9 +154,9 @@ export default class Entry {
     }
 
     /**
-     * @method IncludeSchema
+     * @method includeSchema
      * @deprecated since verion 3.3.0
-     * @description  Include schema of the current contenttype along with entry/entries details.
+     * @description  Include schema of the current content type along with entry/entries details.
      * @example Stack.ContentType("contentType_uid").Entry("entry_uid").includeSchema().fetch()
      * @returns {Entry}
      */
@@ -163,7 +167,7 @@ export default class Entry {
 
     /**
      * @method includeContentType
-     * @description Include the details of the contenttype along with the entry/entries details.
+     * @description Include the details of the content type along with the entry/entries details.
      * @example blogEntry.includeContentType()
      * @returns {Entry}
      */
@@ -185,9 +189,9 @@ export default class Entry {
 
     /**
      * @method toJSON
-     * @description This method is used to convert the result in to plain javascript object.
+     * @description Converts your response into plain JavasScript object.Supports both entry and asset queries.
      * @example
-     * blogEntry
+     * Query
      *      .toJSON()
      *      .then(function (result) {
      *          let value = result.get(field_uid)
@@ -203,10 +207,10 @@ export default class Entry {
 
     /**
      * @method AddParam
-     * @description AddParam method includes query parameter in query.
+     * @description Includes query parameters in your queries. Supports both 'entries' and 'assets' queries.
      * @example var data = blogQuery.addParam('include_count', 'true').fetch()
      *      data.then(function (result) {
-     *          // result is an object which content the data including count in json object form
+     *          // 'result' is an object which content the data including count in json object form
      *       },function (error) {
      *          // error function
      *      })
@@ -223,9 +227,11 @@ export default class Entry {
 
      /**
      * @method fetch
-     * @description Fetches a particular entry based on the provided entry UID.
+     * @description Fetches a particular entry/asset based on the provided entry UID/asset UID.
+     * @example
+     * Stack.blogEntry('entry_uid').toJSON().fetch()
      * @example
-     * Stack.blogEntry('entry_uid').fetch()
+     * Stack.Assets('assets_uid').toJSON().fetch()
      */
     fetch() {
         if (this.entry_uid) {

src/core/modules/entry.js

@@ -80,7 +80,7 @@ const _extend = {
 
 /**
  * @summary
- * Creates an instance of `Query`.
+ * Creates an instance of 'Query'.
  * @description
  * An initializer is responsible for creating Query object.
  * @example
@@ -103,7 +103,7 @@ export default class Query extends Entry {
          * @example let blogQuery = Stack().ContentType('example').Query();
          *          let data = blogQuery.lessThan('created_at','2015-06-22').find()
          *          data.then(function (result) {
-         *          // result content the data who's created_at date is less than '2015-06-22'
+         *          // result content the data who's 'created_at date' is less than '2015-06-22'
          *       },function (error) {
          *          // error function
          *      })
@@ -119,7 +119,7 @@ export default class Query extends Entry {
          * @example let blogQuery = Stack().ContentType('example').Query();
          *          let data = blogQuery.lessThanOrEqualTo('created_at','2015-06-22').find()
          *          data.then(function (result) {
-         *          // result contain the data of entries where the created_at date will be less than or equalto '2015-06-22'.
+         *          // result contain the data of entries where the 'created_at' date will be less than or equalto '2015-06-22'.
          *       },function (error) {
          *          // error function
          *      })
@@ -130,12 +130,12 @@ export default class Query extends Entry {
          * @method greaterThan
          * @description Retrieves entries in which the value for a field is greater than the provided value.
          * @param {String} key - uid of the field
-         * @param {*} value -  value used to match or compare.
+         * @param {*} value -  value used to match or compare
          * @example 
          *          let blogQuery = Stack().ContentType('example').Query();
          *          let data = blogQuery.greaterThan('created_at','2015-03-12').find()
          *                     data.then(function(result) {
-         *                       // result contains the data of entries where the created_at date will be greaterthan '2015-06-22'
+         *                       // result contains the data of entries where the 'created_at' date will be greaterthan '2015-06-22'
          *                     },function (error) {
          *                       // error function
          *                     })
@@ -151,7 +151,7 @@ export default class Query extends Entry {
          * @example let blogQuery = Stack().ContentType('example').Query();
          *          let data = blogQuery.greaterThanOrEqualTo('created_at','2015-03-12').find()
          *          data.then(function(result) {
-         *          // result contains the data of entries where the created_at date will be greaterThan or equalto '2015-06-22'
+         *          // result contains the data of entries where the 'created_at' date will be greaterThan or equalto '2015-06-22'
          *       },function (error) {
          *          // error function
          *      })
@@ -200,7 +200,7 @@ export default class Query extends Entry {
          * @example let blogQuery = Stack().ContentType('example').Query();
          *          let data = blogQuery.notContainedIn('title', ['Demo', 'Welcome']).find()
          *          data.then(function(result) {
-         *          // result contains the list of entries where value of the title field should not be either "Demo" or ‘Welcome’
+         *          // 'result' contains the list of entries where value of the title field should not be either "Demo" or ‘Welcome’
          *       },function (error) {
          *          // error function
          *      })
@@ -243,7 +243,7 @@ export default class Query extends Entry {
          /**
          * @method ascending
          * @description Sort fetched entries in the ascending order with respect to a specific field.
-         * @param {String} key - uid of the field
+         * @param {String} key - field uid based on which the ordering will be done
          * @example let blogQuery = Stack().ContentType('example').Query();
          *          let data = blogQuery.ascending('created_at').find()
          *          data.then(function(result) {
@@ -298,7 +298,7 @@ export default class Query extends Entry {
          * @example let blogQuery = Stack().ContentType('example').Query();
          *          let data = blogQuery.skip(5).find()
          *          data.then(function(result) {
-         *          // result contains the list of data which is sorted in descending order on created_at bases. 
+         *          // result contains the list of data which is sorted in descending order on 'created_at' bases. 
          *       },function (error) {
          *          // error function
          *      })
@@ -370,7 +370,7 @@ export default class Query extends Entry {
     }
 
     /**
-     * @method where()
+     * @method where
      * @description Retrieve entries in which a specific field satisfies the value provided
      * @param {String} key - uid of the field
      * @param {*} value - value used to match or compare
@@ -477,19 +477,7 @@ export default class Query extends Entry {
         return this;
     }
 
-    /**
-     * @method AddParam
-     * @description Retrieves entries based on the query provided
-     * @example blogQuery.addParam('include_count', 'true')
-     * @example let blogQuery = Stack().ContentType('example').Query();
-     *          let data = blogQuery.addParam('include_count', 'true').find()
-     *          data.then(function(result) {
-     *         // ‘result’ contains the count of object present in array[1] position. 
-     *       },function (error) {
-     *          // error function
-     *      })
-     * @returns {Query}
-     */
+    
     addParam(key, value) {
         if (key && value && typeof key === 'string' && typeof value === 'string') {
                 this._query[key] = value;