jqgrid_utils 1.2.17 → 1.2.18

package/README.md

@@ -37,20 +37,22 @@ A module for Jqgrid_utils
 
 * [Jqgrid_utils](#module_Jqgrid_utils)
     * [module.exports#set_link(col_model, edit_field, url)](#exp_module_Jqgrid_utils--module.exports+set_link) ⇒ <code>string</code> ⏏
+    * [module.exports#s_grid_set_caption(_grid, data)](#exp_module_Jqgrid_utils--module.exports+s_grid_set_caption) ⏏
     * [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#s_resize_saved_cell_width(col_model, page, grid)](#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) ⏏
     * [module.exports#resize_cell(the, column, not)](#exp_module_Jqgrid_utils--module.exports+resize_cell) ⏏
-    * [module.exports#upsert_row()](#exp_module_Jqgrid_utils--module.exports+upsert_row) ⏏
-    * [module.exports#insert_row()](#exp_module_Jqgrid_utils--module.exports+insert_row) ⏏
-    * [module.exports#update_row()](#exp_module_Jqgrid_utils--module.exports+update_row) ⏏
-    * [module.exports#delete_row()](#exp_module_Jqgrid_utils--module.exports+delete_row) ⏏
-    * [module.exports#adelete_api()](#exp_module_Jqgrid_utils--module.exports+adelete_api) ⏏
-    * [module.exports#post_json()](#exp_module_Jqgrid_utils--module.exports+post_json) ⏏
-    * [module.exports#put_json()](#exp_module_Jqgrid_utils--module.exports+put_json) ⏏
+    * [module.exports#upsert_row(row, url, req)](#exp_module_Jqgrid_utils--module.exports+upsert_row) ⇒ <code>object</code> ⏏
+    * [module.exports#insert_row(row, url)](#exp_module_Jqgrid_utils--module.exports+insert_row) ⇒ <code>object</code> ⏏
+    * [module.exports#update_row(row, url, req)](#exp_module_Jqgrid_utils--module.exports+update_row) ⇒ <code>object</code> ⏏
+    * [module.exports#delete_row(_id, url)](#exp_module_Jqgrid_utils--module.exports+delete_row) ⇒ <code>object</code> ⏏
+    * [module.exports#adelete_api(url)](#exp_module_Jqgrid_utils--module.exports+adelete_api) ⇒ <code>object</code> ⏏
+    * [module.exports#post_json(url, data)](#exp_module_Jqgrid_utils--module.exports+post_json) ⇒ <code>object</code> ⏏
+    * [module.exports#put_json(url, data)](#exp_module_Jqgrid_utils--module.exports+put_json) ⇒ <code>object</code> ⏏
+    * [module.exports#s_hide_del_icon()](#exp_module_Jqgrid_utils--module.exports+s_hide_del_icon) ⏏
     * [module.exports#hide_del_icon()](#exp_module_Jqgrid_utils--module.exports+hide_del_icon) ⏏
-    * [module.exports#add_link_details()](#exp_module_Jqgrid_utils--module.exports+add_link_details) ⏏
-    * [module.exports#add_link_details_separator()](#exp_module_Jqgrid_utils--module.exports+add_link_details_separator) ⏏
+    * [module.exports#add_link_details(col_model, url, edit_field, attr, keys)](#exp_module_Jqgrid_utils--module.exports+add_link_details) ⏏
+    * [module.exports#add_link_details_separator(col_model, url, edit_field, attr, keys)](#exp_module_Jqgrid_utils--module.exports+add_link_details_separator) ⏏
     * [module.exports#__cell_format()](#exp_module_Jqgrid_utils--module.exports+__cell_format) ⏏
     * [module.exports#subgrid(_id, id, data_url, col_model, caption)](#exp_module_Jqgrid_utils--module.exports+subgrid) ⏏
     * [module.exports#add_image(col_model, edit_field, size, link)](#exp_module_Jqgrid_utils--module.exports+add_image) ⏏
@@ -73,8 +75,26 @@ Add an URL from the data to a specific cell/column
 
 **Example**  
 ```js
+var jqu = new Jqgrid_utils();
 col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"');
 ```
+<a name="exp_module_Jqgrid_utils--module.exports+s_grid_set_caption"></a>
+
+### module.exports#s\_grid\_set\_caption(_grid, data) ⏏
+**Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| _grid | <code>object</code> | gridobject; |
+| data | <code>object</code> | grid data (optional); |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+loadComplete: function(){
+  jqu.grid_set_caption(this);
+},
+```
 <a name="exp_module_Jqgrid_utils--module.exports+grid_set_caption"></a>
 
 ### module.exports#grid\_set\_caption(_grid, data) ⏏
@@ -89,13 +109,24 @@ col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"')
 ```js
 var jqu = new Jqgrid_utils();
 loadComplete: function(){
-  jqu.grid_set_caption(this);
+  await jqu.grid_set_caption(this);
 },
 ```
 <a name="exp_module_Jqgrid_utils--module.exports+s_resize_saved_cell_width"></a>
 
-### module.exports#s\_resize\_saved\_cell\_width() ⏏
+### module.exports#s\_resize\_saved\_cell\_width(col_model, page, grid) ⏏
 **Kind**: Exported function  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| col_model | <code>object</code> |  | the col_model of the grid |
+| page | <code>string</code> | <code>false</code> | the name of the page(optional) |
+| grid | <code>object</code> | <code>false</code> | the grid objec(optional) |
+
+**Example**  
+```js
+col_model = await jqu.resize_saved_cell_width(col_model);
+```
 <a name="exp_module_Jqgrid_utils--module.exports+resize_saved_cell_width"></a>
 
 ### module.exports#resize\_saved\_cell\_width(col_model, page, grid) ⏏
@@ -129,55 +160,218 @@ resizeStop: jqu.resize_cell,
 ```
 <a name="exp_module_Jqgrid_utils--module.exports+upsert_row"></a>
 
-### module.exports#upsert\_row() ⏏
+### module.exports#upsert\_row(row, url, req) ⇒ <code>object</code> ⏏
+Upsert(insert or update) from the grid to an API
+
 **Kind**: Exported function  
+**Returns**: <code>object</code> - {update: 'ok'} or {udpate: 'failed'}  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| row | <code>object</code> | row object |
+| url | <code>string</code> | url of the API |
+| req | <code>string</code> | data oject |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+afterSetRow: async function(row)
+{
+  let r = await jqu.upsert_row(row, url);
+  console.log(r);
+},
+```
 <a name="exp_module_Jqgrid_utils--module.exports+insert_row"></a>
 
-### module.exports#insert\_row() ⏏
+### module.exports#insert\_row(row, url) ⇒ <code>object</code> ⏏
+Insert from the grid to an API used by the upsert_row function
+
 **Kind**: Exported function  
+**Returns**: <code>object</code> - Object from the the API like {update: 'ok'} or {update: 'failed'}  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| row | <code>object</code> | row object |
+| url | <code>string</code> | url of the API |
+|  | <code>string</code> | data oject |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+afterSetRow: async function(row)
+{
+  let r = await jqu.upsert_row(row, url);
+  console.log(r);
+},
+```
 <a name="exp_module_Jqgrid_utils--module.exports+update_row"></a>
 
-### module.exports#update\_row() ⏏
+### module.exports#update\_row(row, url, req) ⇒ <code>object</code> ⏏
+Update from the grid to an API used by the upsert_row function
+
 **Kind**: Exported function  
+**Returns**: <code>object</code> - Object from the the API like {update: 'ok'} or {update: 'failed'}  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| row | <code>object</code> | row object |
+| url | <code>string</code> | url of the API |
+| req | <code>string</code> | data oject |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+afterSetRow: async function(row)
+{
+  let r = await jqu.upsert_row(row, url);
+  console.log(r);
+},
+```
 <a name="exp_module_Jqgrid_utils--module.exports+delete_row"></a>
 
-### module.exports#delete\_row() ⏏
+### module.exports#delete\_row(_id, url) ⇒ <code>object</code> ⏏
+Delete from the grid to an API
+
 **Kind**: Exported function  
+**Returns**: <code>object</code> - @returns {object} Object from the the API like {delete: 'ok'} or {delete: 'failed'}  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| _id | <code>string</code> | row id |
+| url | <code>string</code> | url of the API |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+afterDelRow: async function(row)
+{
+  const r = await jqu.delete_row(row, url);
+  console.log(r + ' : ' + row + ' - from API');
+},
+```
 <a name="exp_module_Jqgrid_utils--module.exports+adelete_api"></a>
 
-### module.exports#adelete\_api() ⏏
+### module.exports#adelete\_api(url) ⇒ <code>object</code> ⏏
+Async Delete request used by function delete_row
+
 **Kind**: Exported function  
+**Returns**: <code>object</code> - @returns {object} Object from the the API like {delete: 'ok'} or {delete: 'failed'}  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| url | <code>string</code> | url of the API |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+afterDelRow: async function(row)
+{
+  ret = JSON.parse(await jqu.adelete_api(url));
+},
+```
 <a name="exp_module_Jqgrid_utils--module.exports+post_json"></a>
 
-### module.exports#post\_json() ⏏
+### module.exports#post\_json(url, data) ⇒ <code>object</code> ⏏
+Async Post request used by the update_row function
+
 **Kind**: Exported function  
+**Returns**: <code>object</code> - @returns {object} Object from the the API like {update: 'ok'} or {update: 'failed'}  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| url | <code>string</code> | url of the API |
+| data | <code>object</code> | json object |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+ret = JSON.parse(await jqu.post_json(url,{'key':value,'key2':'value'}));
+```
 <a name="exp_module_Jqgrid_utils--module.exports+put_json"></a>
 
-### module.exports#put\_json() ⏏
+### module.exports#put\_json(url, data) ⇒ <code>object</code> ⏏
+Async Put request used by the insert_row function
+
 **Kind**: Exported function  
+**Returns**: <code>object</code> - @returns {object} Object from the the API like {insert: 'ok'} or {insert: 'failed'}  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| url | <code>string</code> | url of the API |
+| data | <code>object</code> | json object |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+ret = JSON.parse(await jqu.put_json(url,{'key':value,'key2':'value2'}));
+```
+<a name="exp_module_Jqgrid_utils--module.exports+s_hide_del_icon"></a>
+
+### module.exports#s\_hide\_del\_icon() ⏏
+Hide the del iconf rom the grid
+
+**Kind**: Exported function  
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+jqu.hide_del_icon();
+```
 <a name="exp_module_Jqgrid_utils--module.exports+hide_del_icon"></a>
 
 ### module.exports#hide\_del\_icon() ⏏
+Hide the del iconf rom the grid
+
 **Kind**: Exported function  
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+await jqu.hide_del_icon();
+```
 <a name="exp_module_Jqgrid_utils--module.exports+add_link_details"></a>
 
-### module.exports#add\_link\_details() ⏏
+### module.exports#add\_link\_details(col_model, url, edit_field, attr, keys) ⏏
+Convert a cell into a link/url with data from another cell
+
 **Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| col_model | <code>object</code> | col_model of the grid |
+| url | <code>string</code> | URL string |
+| edit_field | <code>string</code> | Column/Cell to use |
+| attr | <code>string</code> | URL Attributes |
+| keys | <code>object</code> | keys and fields value to use |
+
 **Example**  
 ```js
-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"});
 ```
 <a name="exp_module_Jqgrid_utils--module.exports+add_link_details_separator"></a>
 
-### module.exports#add\_link\_details\_separator() ⏏
+### module.exports#add\_link\_details\_separator(col_model, url, edit_field, attr, keys) ⏏
+Convert a cell into seperated based link/url like https://foo.bar.com/field/value/field/value
+
 **Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| col_model | <code>object</code> | col_model of the grid |
+| url | <code>string</code> | URL string |
+| edit_field | <code>string</code> | Column/Cell to use |
+| attr | <code>string</code> | URL Attributes |
+| keys | <code>object</code> | keys and fields value to use |
+
 **Example**  
 ```js
+var jqu = new Jqgrid_utils();
 col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
 ```
 <a name="exp_module_Jqgrid_utils--module.exports+__cell_format"></a>
 
 ### module.exports#\_\_cell\_format() ⏏
+Private Function
+
 **Kind**: Exported function  
 <a name="exp_module_Jqgrid_utils--module.exports+subgrid"></a>
 

package/package.json

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