jqgrid_utils 1.2.14 → 1.2.17

package/README.md

@@ -36,7 +36,7 @@ A module for Jqgrid_utils
 
 
 * [Jqgrid_utils](#module_Jqgrid_utils)
-    * [module.exports#set_link()](#exp_module_Jqgrid_utils--module.exports+set_link) ⏏
+    * [module.exports#set_link(col_model, edit_field, url)](#exp_module_Jqgrid_utils--module.exports+set_link) ⇒ <code>string</code> ⏏
     * [module.exports#grid_set_caption(_grid, data)](#exp_module_Jqgrid_utils--module.exports+grid_set_caption) ⏏
     * [module.exports#s_resize_saved_cell_width()](#exp_module_Jqgrid_utils--module.exports+s_resize_saved_cell_width) ⏏
     * [module.exports#resize_saved_cell_width(col_model, page, grid)](#exp_module_Jqgrid_utils--module.exports+resize_saved_cell_width) ⏏
@@ -59,8 +59,22 @@ A module for Jqgrid_utils
 
 <a name="exp_module_Jqgrid_utils--module.exports+set_link"></a>
 
-### module.exports#set\_link() ⏏
+### module.exports#set\_link(col_model, edit_field, url) ⇒ <code>string</code> ⏏
+Add an URL from the data to a specific cell/column
+
 **Kind**: Exported function  
+**Returns**: <code>string</code> - https://foo.bar.com/av0_code/bar  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| col_model | <code>object</code> | col_model of the grid |
+| edit_field | <code>string</code> | name of the column what should get convert to the url |
+| url | <code>string</code> | the used url of the data |
+
+**Example**  
+```js
+col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"');
+```
 <a name="exp_module_Jqgrid_utils--module.exports+grid_set_caption"></a>
 
 ### module.exports#grid\_set\_caption(_grid, data) ⏏

package/dist/jqgrid_utils.js

@@ -28,7 +28,15 @@ module.exports = class Vanilla_website_utils
   }
 
 /**
+* Add an URL from the data to a specific cell/column
 @alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - name of the column what should get convert to the url
+@param {string} - the used url of the data 
+@returns {string} https://foo.bar.com/av0_code/bar 
+@example
+var jqu = new Jqgrid_utils();
+col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"');
 */
   async set_link(col_model, edit_field, url ,attr='')
   {
@@ -45,6 +53,16 @@ module.exports = class Vanilla_website_utils
     return col_model;
   }
 
+/**
+@alias module:Jqgrid_utils
+@param {object} - gridobject;
+@param {object} - grid data (optional);
+@example 
+var jqu = new Jqgrid_utils();
+loadComplete: function(){
+  jqu.grid_set_caption(this);
+},
+*/
 
   s_grid_set_caption(_grid, data=[])
   {
@@ -58,7 +76,7 @@ module.exports = class Vanilla_website_utils
 @example 
 var jqu = new Jqgrid_utils();
 loadComplete: function(){
-  jqu.grid_set_caption(this);
+  await jqu.grid_set_caption(this);
 },
 */
   async grid_set_caption(_grid, data=[])
@@ -81,6 +99,11 @@ loadComplete: function(){
 
 /**
 @alias module:Jqgrid_utils
+@param {object} - the col_model of the grid
+@param {string} - the name of the page(optional)
+@param {object} - the grid objec(optional)
+@example 
+col_model = await jqu.resize_saved_cell_width(col_model);
 */
   s_resize_saved_cell_width(col_model, page=false, grid=false)
   {
@@ -147,7 +170,19 @@ col_model = await jqu.resize_saved_cell_width(col_model);
 
 
 /**
+* Upsert(insert or update) from the grid to an API 
 @alias module:Jqgrid_utils
+@param {object} - row object
+@param {string} - url of the API
+@param {string} - data oject 
+@returns {object} {update: 'ok'} or {udpate: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterSetRow: async function(row)
+{
+  let r = await jqu.upsert_row(row, url);
+  console.log(r);
+},
 */
 async upsert_row(row, url, req = {})
 {
@@ -163,8 +198,21 @@ async upsert_row(row, url, req = {})
   }
 }
 
+
 /**
+* Insert from the grid to an API used by the upsert_row function 
 @alias module:Jqgrid_utils
+@param {object} - row object
+@param {string} - url of the API
+@param {string} - data oject 
+@returns {object} Object from the the API like {update: 'ok'} or {update: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterSetRow: async function(row)
+{
+  let r = await jqu.upsert_row(row, url);
+  console.log(r);
+},
 */
 async insert_row(row, url)
 {
@@ -188,8 +236,21 @@ async insert_row(row, url)
 
 
 /**
+* Update from the grid to an API used by the upsert_row function 
 @alias module:Jqgrid_utils
+@param {object} - row object
+@param {string} - url of the API
+@param {string} - data oject 
+@returns {object} Object from the the API like {update: 'ok'} or {update: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterSetRow: async function(row)
+{
+  let r = await jqu.upsert_row(row, url);
+  console.log(r);
+},
 */
+
 async  update_row(row, url, req = {})
 {
   let ret = '';
@@ -211,8 +272,20 @@ async  update_row(row, url, req = {})
 }
 
 /**
+* Delete from the grid to an API 
 @alias module:Jqgrid_utils
+@param {string} - row id
+@param {string} - url of the API
+@returns {object} @returns {object} Object from the the API like {delete: 'ok'} or {delete: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterDelRow: async function(row)
+{
+  const r = await jqu.delete_row(row, url);
+  console.log(r + ' : ' + row + ' - from API');
+},
 */
+
 async delete_row(_id, url)
 {
   let ret = '';
@@ -231,8 +304,18 @@ async delete_row(_id, url)
 
 
 /**
+* Async Delete request used by function delete_row
 @alias module:Jqgrid_utils
+@param {string} - url of the API
+@returns {object} @returns {object} Object from the the API like {delete: 'ok'} or {delete: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterDelRow: async function(row)
+{
+  ret = JSON.parse(await jqu.adelete_api(url));
+},
 */
+
 async adelete_api(url, json = false)
 {
   const ctype = json ? "application/json;charset=UTF-8" : "application/x-www-form-urlencoded";
@@ -248,9 +331,18 @@ async adelete_api(url, json = false)
 }
 
 
+
 /**
+* Async Post request used by the update_row function
 @alias module:Jqgrid_utils
+@param {string} - url of the API
+@param {object} - json object
+@returns {object} @returns {object} Object from the the API like {update: 'ok'} or {update: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+ret = JSON.parse(await jqu.post_json(url,{'key':value,'key2':'value'}));
 */
+
 async post_json(url, data)
 {
   return new Promise((resolve, reject) =>
@@ -265,7 +357,14 @@ async post_json(url, data)
 }
 
 /**
+* Async Put request used by the insert_row function
 @alias module:Jqgrid_utils
+@param {string} - url of the API
+@param {object} - json object
+@returns {object} @returns {object} Object from the the API like {insert: 'ok'} or {insert: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+ret = JSON.parse(await jqu.put_json(url,{'key':value,'key2':'value2'}));
 */
 async put_json(url, data)
 {
@@ -280,14 +379,24 @@ async put_json(url, data)
   });
 }
 
-
+/**
+* Hide the del iconf rom the grid
+@alias module:Jqgrid_utils
+@example
+var jqu = new Jqgrid_utils();
+jqu.hide_del_icon();
+*/
 s_hide_del_icon()
 {
   hide_del_icon();   
 }
 
 /**
+* Hide the del iconf rom the grid
 @alias module:Jqgrid_utils
+@example
+var jqu = new Jqgrid_utils();
+await jqu.hide_del_icon();
 */
 async hide_del_icon()
 {
@@ -297,9 +406,16 @@ async hide_del_icon()
 
 
 /**
+* Convert a cell into a link/url with data from another cell
 @alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - Column/Cell to use
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
 @example 
-* example: col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
 */
 async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 {
@@ -369,9 +485,16 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 
 
 /**
+* Convert a cell into seperated based link/url like https://foo.bar.com/field/value/field/value
 @alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - Column/Cell to use
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
 @example 
-* col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
 */
 async add_link_details_separator(col_model, url, edit_field, attr = '', keys, format)
 {
@@ -436,6 +559,7 @@ async add_link_details_separator(col_model, url, edit_field, attr = '', keys, fo
 
 
 /**
+* Private Function
 @alias module:Jqgrid_utils
 */
 __cell_format(cell_value, format)

package/jqgrid_utils.js

@@ -27,7 +27,15 @@ module.exports = class Vanilla_website_utils
   }
 
 /**
+* Add an URL from the data to a specific cell/column
 @alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - name of the column what should get convert to the url
+@param {string} - the used url of the data 
+@returns {string} https://foo.bar.com/av0_code/bar 
+@example
+var jqu = new Jqgrid_utils();
+col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"');
 */
   async set_link(col_model, edit_field, url ,attr='')
   {
@@ -44,6 +52,16 @@ module.exports = class Vanilla_website_utils
     return col_model;
   }
 
+/**
+@alias module:Jqgrid_utils
+@param {object} - gridobject;
+@param {object} - grid data (optional);
+@example 
+var jqu = new Jqgrid_utils();
+loadComplete: function(){
+  jqu.grid_set_caption(this);
+},
+*/
 
   s_grid_set_caption(_grid, data=[])
   {
@@ -57,7 +75,7 @@ module.exports = class Vanilla_website_utils
 @example 
 var jqu = new Jqgrid_utils();
 loadComplete: function(){
-  jqu.grid_set_caption(this);
+  await jqu.grid_set_caption(this);
 },
 */
   async grid_set_caption(_grid, data=[])
@@ -80,6 +98,11 @@ loadComplete: function(){
 
 /**
 @alias module:Jqgrid_utils
+@param {object} - the col_model of the grid
+@param {string} - the name of the page(optional)
+@param {object} - the grid objec(optional)
+@example 
+col_model = await jqu.resize_saved_cell_width(col_model);
 */
   s_resize_saved_cell_width(col_model, page=false, grid=false)
   {
@@ -146,7 +169,19 @@ col_model = await jqu.resize_saved_cell_width(col_model);
 
 
 /**
+* Upsert(insert or update) from the grid to an API 
 @alias module:Jqgrid_utils
+@param {object} - row object
+@param {string} - url of the API
+@param {string} - data oject 
+@returns {object} {update: 'ok'} or {udpate: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterSetRow: async function(row)
+{
+  let r = await jqu.upsert_row(row, url);
+  console.log(r);
+},
 */
 async upsert_row(row, url, req = {})
 {
@@ -162,8 +197,21 @@ async upsert_row(row, url, req = {})
   }
 }
 
+
 /**
+* Insert from the grid to an API used by the upsert_row function 
 @alias module:Jqgrid_utils
+@param {object} - row object
+@param {string} - url of the API
+@param {string} - data oject 
+@returns {object} Object from the the API like {update: 'ok'} or {update: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterSetRow: async function(row)
+{
+  let r = await jqu.upsert_row(row, url);
+  console.log(r);
+},
 */
 async insert_row(row, url)
 {
@@ -187,8 +235,21 @@ async insert_row(row, url)
 
 
 /**
+* Update from the grid to an API used by the upsert_row function 
 @alias module:Jqgrid_utils
+@param {object} - row object
+@param {string} - url of the API
+@param {string} - data oject 
+@returns {object} Object from the the API like {update: 'ok'} or {update: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterSetRow: async function(row)
+{
+  let r = await jqu.upsert_row(row, url);
+  console.log(r);
+},
 */
+
 async  update_row(row, url, req = {})
 {
   let ret = '';
@@ -210,8 +271,20 @@ async  update_row(row, url, req = {})
 }
 
 /**
+* Delete from the grid to an API 
 @alias module:Jqgrid_utils
+@param {string} - row id
+@param {string} - url of the API
+@returns {object} @returns {object} Object from the the API like {delete: 'ok'} or {delete: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterDelRow: async function(row)
+{
+  const r = await jqu.delete_row(row, url);
+  console.log(r + ' : ' + row + ' - from API');
+},
 */
+
 async delete_row(_id, url)
 {
   let ret = '';
@@ -230,8 +303,18 @@ async delete_row(_id, url)
 
 
 /**
+* Async Delete request used by function delete_row
 @alias module:Jqgrid_utils
+@param {string} - url of the API
+@returns {object} @returns {object} Object from the the API like {delete: 'ok'} or {delete: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+afterDelRow: async function(row)
+{
+  ret = JSON.parse(await jqu.adelete_api(url));
+},
 */
+
 async adelete_api(url, json = false)
 {
   const ctype = json ? "application/json;charset=UTF-8" : "application/x-www-form-urlencoded";
@@ -247,9 +330,18 @@ async adelete_api(url, json = false)
 }
 
 
+
 /**
+* Async Post request used by the update_row function
 @alias module:Jqgrid_utils
+@param {string} - url of the API
+@param {object} - json object
+@returns {object} @returns {object} Object from the the API like {update: 'ok'} or {update: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+ret = JSON.parse(await jqu.post_json(url,{'key':value,'key2':'value'}));
 */
+
 async post_json(url, data)
 {
   return new Promise((resolve, reject) =>
@@ -264,7 +356,14 @@ async post_json(url, data)
 }
 
 /**
+* Async Put request used by the insert_row function
 @alias module:Jqgrid_utils
+@param {string} - url of the API
+@param {object} - json object
+@returns {object} @returns {object} Object from the the API like {insert: 'ok'} or {insert: 'failed'}
+@example
+var jqu = new Jqgrid_utils();
+ret = JSON.parse(await jqu.put_json(url,{'key':value,'key2':'value2'}));
 */
 async put_json(url, data)
 {
@@ -279,14 +378,24 @@ async put_json(url, data)
   });
 }
 
-
+/**
+* Hide the del iconf rom the grid
+@alias module:Jqgrid_utils
+@example
+var jqu = new Jqgrid_utils();
+jqu.hide_del_icon();
+*/
 s_hide_del_icon()
 {
   hide_del_icon();   
 }
 
 /**
+* Hide the del iconf rom the grid
 @alias module:Jqgrid_utils
+@example
+var jqu = new Jqgrid_utils();
+await jqu.hide_del_icon();
 */
 async hide_del_icon()
 {
@@ -296,9 +405,16 @@ async hide_del_icon()
 
 
 /**
+* Convert a cell into a link/url with data from another cell
 @alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - Column/Cell to use
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
 @example 
-* example: col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
 */
 async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 {
@@ -368,9 +484,16 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 
 
 /**
+* Convert a cell into seperated based link/url like https://foo.bar.com/field/value/field/value
 @alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - Column/Cell to use
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
 @example 
-* col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
 */
 async add_link_details_separator(col_model, url, edit_field, attr = '', keys, format)
 {
@@ -435,6 +558,7 @@ async add_link_details_separator(col_model, url, edit_field, attr = '', keys, fo
 
 
 /**
+* Private Function
 @alias module:Jqgrid_utils
 */
 __cell_format(cell_value, format)

package/package.json

@@ -29,5 +29,5 @@
   {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "1.2.14"
+  "version": "1.2.17"
 }