datatable-axios 0.0.8 → 0.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/Readme.md +28 -11
  3. package/package.json +59 -59
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Mahmudun Nabi Kajal
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/Readme.md CHANGED
@@ -1,4 +1,9 @@
1
1
  # Datatable Axios
2
+ [![mahmudunnabikajal - datatable-axios](https://img.shields.io/static/v1?label=mahmudunnabikajal&message=datatable-axios&color=blue&logo=github)](https://github.com/mahmudunnabikajal/datatable-axios "Go to GitHub repo")
3
+ [![Latest Stable Version](https://img.shields.io/npm/v/datatable-axios.svg)](https://www.npmjs.com/package/datatable-axios)
4
+ [![NPM Downloads](https://img.shields.io/npm/dt/datatable-axios.svg)](https://www.npmjs.com/package/datatable-axios)
5
+ [![License](https://img.shields.io/badge/License-MIT-blue)](#license)
6
+ <!-- [![Documentation](https://img.shields.io/badge/Documentation-blue)](./docs/index.html "Go to project documentation") -->
2
7
 
3
8
 
4
9
  Datatable Axios is a simple and convenient npm package that helps you make GET, POST, and PUT requests with ease, while handling search parameters and pagination seamlessly. It's built on top of the popular Axios library, making it reliable and efficient for your data fetching needs.
@@ -11,6 +16,20 @@ You can install Datatable Axios using npm:
11
16
  npm install datatable-axios
12
17
  ```
13
18
  &nbsp;
19
+ # Why Datatable Axios?
20
+ Simplify your `HTTP calls without repetition`. Say goodbye to repeating steps for every datatable request!
21
+
22
+ - **`Cons:`** Without using the library, you can achieve the same functionality in Axios which `isn't readable & reusable`.
23
+ ```js
24
+ const response = await axios.get('http://example.com/api/v1/products?page=2&paginate=25&search=we');
25
+ console.log(response.data);
26
+ ```
27
+ - **`Pros:`** After using this library, you can achieve the same functionality of Axios in a `readable & reusable way`
28
+ ```js
29
+ const response = await datatable.get('products');
30
+ console.log(response.data);
31
+ ```
32
+ &nbsp;
14
33
  # Usage
15
34
  To get started with Datatable Axios, follow these simple steps:
16
35
 
@@ -39,14 +58,14 @@ const datatable = new Datatable();
39
58
  &nbsp;
40
59
  # Use of API URL:
41
60
 
42
- - When you have a global `axios.js` configuration setting your baseURL, simplify your API calls by using just the path:
61
+ - When you have a global `axios.js` configuration setting with baseURL, simplify calls API by using just the path:
43
62
  ```js
44
63
  const response = await datatable.get('products');
45
64
  console.log(response.data);
46
65
  ```
47
- - If you're not utilizing a global `axios.js` configuration for your baseURL, include the full URL when making API calls:
66
+ - If you're not utilizing a global `axios.js` configuration for with baseURL, include the full URL when making API calls:
48
67
  ```js
49
- const response = await datatable.get('url or path');
68
+ const response = await datatable.get('http://example.com/api/v1/products');
50
69
  console.log(response.data);
51
70
  ```
52
71
  &nbsp;
@@ -88,6 +107,7 @@ try {
88
107
  console.error("An error occurred:", error);
89
108
  }
90
109
  ```
110
+ **`Note:`** Similar usage for POST and PUT requests
91
111
  <!-- # Advanced Usage
92
112
  You can also pass search parameters, pagination, and search queries to your requests:
93
113
 
@@ -99,9 +119,6 @@ const response = await datatable.get('https://api.example.com/data', {
99
119
  search: 'keyword',
100
120
  });
101
121
  console.log(response.data);
102
-
103
- // Similar usage for POST and PUT requests
104
-
105
122
  ``` -->
106
123
 
107
124
  &nbsp;
@@ -110,11 +127,11 @@ We welcome contributions to enhance Datatable Axios! Feel free to open issues fo
110
127
 
111
128
  &nbsp;
112
129
  # License
113
- Datatable Axios is released under the [MIT License](https://opensource.org/license/mit/).
130
+ Released under [MIT License](LICENSE) by [@mahmudunnabikajal](https://github.com/mahmudunnabikajal).
114
131
 
115
132
  &nbsp;
133
+ # Author
134
+ Mahmudun Nabi Kajal<br />
135
+ Contact: [Linkedin](https://www.linkedin.com/in/mahmudun-nabi-kajal/), [GitHub](https://github.com/mahmudunnabikajal), [Gmail](mailto:mahmudunnabikajal)
116
136
 
117
- Feel free to reach out to me at &nbsp;[<svg xmlns="http://www.w3.org/2000/svg" width="24" height="18.1" viewBox="0 0 256 193"><path fill="#4285F4" d="M58.182 192.05V93.14L27.507 65.077L0 49.504v125.091c0 9.658 7.825 17.455 17.455 17.455h40.727Z"/><path fill="#34A853" d="M197.818 192.05h40.727c9.659 0 17.455-7.826 17.455-17.455V49.505l-31.156 17.837l-27.026 25.798v98.91Z"/><path fill="#EA4335" d="m58.182 93.14l-4.174-38.647l4.174-36.989L128 69.868l69.818-52.364l4.669 34.992l-4.669 40.644L128 145.504z"/><path fill="#FBBC04" d="M197.818 17.504V93.14L256 49.504V26.231c0-21.585-24.64-33.89-41.89-20.945l-16.292 12.218Z"/><path fill="#C5221F" d="m0 49.504l26.759 20.07L58.182 93.14V17.504L41.89 5.286C24.61-7.66 0 4.646 0 26.23v23.273Z"/></svg>](mailto:mahmudunnabikajal@gmail.com)&nbsp;
118
- [<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 128 128"><g fill="#fff"><path fill-rule="evenodd" d="M64 5.103c-33.347 0-60.388 27.035-60.388 60.388c0 26.682 17.303 49.317 41.297 57.303c3.017.56 4.125-1.31 4.125-2.905c0-1.44-.056-6.197-.082-11.243c-16.8 3.653-20.345-7.125-20.345-7.125c-2.747-6.98-6.705-8.836-6.705-8.836c-5.48-3.748.413-3.67.413-3.67c6.063.425 9.257 6.223 9.257 6.223c5.386 9.23 14.127 6.562 17.573 5.02c.542-3.903 2.107-6.568 3.834-8.076c-13.413-1.525-27.514-6.704-27.514-29.843c0-6.593 2.36-11.98 6.223-16.21c-.628-1.52-2.695-7.662.584-15.98c0 0 5.07-1.623 16.61 6.19C53.7 35 58.867 34.327 64 34.304c5.13.023 10.3.694 15.127 2.033c11.526-7.813 16.59-6.19 16.59-6.19c3.287 8.317 1.22 14.46.593 15.98c3.872 4.23 6.215 9.617 6.215 16.21c0 23.194-14.127 28.3-27.574 29.796c2.167 1.874 4.097 5.55 4.097 11.183c0 8.08-.07 14.583-.07 16.572c0 1.607 1.088 3.49 4.148 2.897c23.98-7.994 41.263-30.622 41.263-57.294C124.388 32.14 97.35 5.104 64 5.104z" clip-rule="evenodd"/><path d="M26.484 91.806c-.133.3-.605.39-1.035.185c-.44-.196-.685-.605-.543-.906c.13-.31.603-.395 1.04-.188c.44.197.69.61.537.91zm2.446 2.729c-.287.267-.85.143-1.232-.28c-.396-.42-.47-.983-.177-1.254c.298-.266.844-.14 1.24.28c.394.426.472.984.17 1.255zm2.382 3.477c-.37.258-.976.017-1.35-.52c-.37-.538-.37-1.183.01-1.44c.373-.258.97-.025 1.35.507c.368.545.368 1.19-.01 1.452zm3.261 3.361c-.33.365-1.036.267-1.552-.23c-.527-.487-.674-1.18-.343-1.544c.336-.366 1.045-.264 1.564.23c.527.486.686 1.18.333 1.543zm4.5 1.951c-.147.473-.825.688-1.51.486c-.683-.207-1.13-.76-.99-1.238c.14-.477.823-.7 1.512-.485c.683.206 1.13.756.988 1.237zm4.943.361c.017.498-.563.91-1.28.92c-.723.017-1.308-.387-1.315-.877c0-.503.568-.91 1.29-.924c.717-.013 1.306.387 1.306.88zm4.598-.782c.086.485-.413.984-1.126 1.117c-.7.13-1.35-.172-1.44-.653c-.086-.498.422-.997 1.122-1.126c.714-.123 1.354.17 1.444.663zm0 0"/></g></svg>](https://github.com/mahmudunnabikajal)&nbsp;
119
- [<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 128 128"><path fill="#0076b2" d="M116 3H12a8.91 8.91 0 0 0-9 8.8v104.42a8.91 8.91 0 0 0 9 8.78h104a8.93 8.93 0 0 0 9-8.81V11.77A8.93 8.93 0 0 0 116 3z"/><path fill="#fff" d="M21.06 48.73h18.11V107H21.06zm9.06-29a10.5 10.5 0 1 1-10.5 10.49a10.5 10.5 0 0 1 10.5-10.49m20.41 29h17.36v8h.24c2.42-4.58 8.32-9.41 17.13-9.41C103.6 47.28 107 59.35 107 75v32H88.89V78.65c0-6.75-.12-15.44-9.41-15.44s-10.87 7.36-10.87 15V107H50.53z"/></svg>](https://www.linkedin.com/in/mahmudun-nabi-kajal/)&nbsp;
120
- for any questions or feedback! We hope Datatable Axios simplifies your data fetching process.
137
+ Feel free to reach out to me for any questions or feedback! I hope Datatable Axios simplifies your data fetching process for your datatable.
package/package.json CHANGED
@@ -1,59 +1,59 @@
1
- {
2
- "name": "datatable-axios",
3
- "version": "0.0.8",
4
- "description": "A powerful npm package for effortless datatable interactions with seamless Axios calls. Effortlessly integrate search, paginate, and pagination functionalities into your projects with ease.",
5
- "type": "module",
6
- "main": "dist/datatable-axios.cjs.js",
7
- "unpkg": "dist/datatable-axios.umd.js",
8
- "jsdelivr": "dist/simple-datatables.umd.js",
9
- "exports": {
10
- ".": {
11
- "import": "./dist/datatable-axios.esm.js",
12
- "require": "./dist/datatable-axios.cjs.js"
13
- }
14
- },
15
- "scripts": {
16
- "build": "npm run build:rollup",
17
- "build:vite": "vite build",
18
- "build:rollup": "rollup -c"
19
- },
20
- "repository": {
21
- "type": "git",
22
- "url": "git+https://github.com/mahmudunnabikajal/datatable-axios.git"
23
- },
24
- "keywords": [
25
- "datatable",
26
- "axiosdatatable",
27
- "datatableaxios",
28
- "datatable-axios",
29
- "DataTables",
30
- "DataTable",
31
- "table",
32
- "grid",
33
- "filter",
34
- "sort",
35
- "page",
36
- "javascript-plugin",
37
- "vite",
38
- "npm",
39
- "package"
40
- ],
41
- "author": "Mahmudun Nabi Kajal",
42
- "license": "ISC",
43
- "bugs": {
44
- "url": "https://github.com/mahmudunnabikajal/datatable-axios/issues"
45
- },
46
- "homepage": "https://github.com/mahmudunnabikajal/datatable-axios#readme",
47
- "peerDependencies": {
48
- "axios": "*"
49
- },
50
- "devDependencies": {
51
- "vite": "^4.4.9",
52
- "@rollup/plugin-commonjs": "^25.0.4",
53
- "@rollup/plugin-node-resolve": "^15.2.0",
54
- "rollup": "^3.28.0"
55
- },
56
- "dependencies": {
57
- "axios": "^1.4.0"
58
- }
59
- }
1
+ {
2
+ "name": "datatable-axios",
3
+ "version": "0.0.9",
4
+ "description": "A powerful npm package for effortless datatable interactions with seamless Axios calls. Effortlessly integrate search, paginate, and pagination functionalities into your projects with ease.",
5
+ "type": "module",
6
+ "main": "dist/datatable-axios.cjs.js",
7
+ "unpkg": "dist/datatable-axios.umd.js",
8
+ "jsdelivr": "dist/simple-datatables.umd.js",
9
+ "exports": {
10
+ ".": {
11
+ "import": "./dist/datatable-axios.esm.js",
12
+ "require": "./dist/datatable-axios.cjs.js"
13
+ }
14
+ },
15
+ "scripts": {
16
+ "build": "npm run build:rollup",
17
+ "build:vite": "vite build",
18
+ "build:rollup": "rollup -c"
19
+ },
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "git+https://github.com/mahmudunnabikajal/datatable-axios.git"
23
+ },
24
+ "keywords": [
25
+ "datatable",
26
+ "axiosdatatable",
27
+ "datatableaxios",
28
+ "datatable-axios",
29
+ "DataTables",
30
+ "DataTable",
31
+ "table",
32
+ "grid",
33
+ "filter",
34
+ "sort",
35
+ "page",
36
+ "javascript-plugin",
37
+ "vite",
38
+ "npm",
39
+ "package"
40
+ ],
41
+ "author": "Mahmudun Nabi Kajal",
42
+ "license": "MIT",
43
+ "bugs": {
44
+ "url": "https://github.com/mahmudunnabikajal/datatable-axios/issues"
45
+ },
46
+ "homepage": "https://mahmudunnabikajal.github.io/datatable-axios/",
47
+ "peerDependencies": {
48
+ "axios": "*"
49
+ },
50
+ "devDependencies": {
51
+ "vite": "^4.4.9",
52
+ "@rollup/plugin-commonjs": "^25.0.4",
53
+ "@rollup/plugin-node-resolve": "^15.2.0",
54
+ "rollup": "^3.28.0"
55
+ },
56
+ "dependencies": {
57
+ "axios": "^1.4.0"
58
+ }
59
+ }