Datatable Axios Documentation

Installation

npm install -g datatable-axios

Why Datatable Axios?

Simplify your HTTP calls without repetition. Say goodbye to repeating steps for every datatable request!

Cons:

Without using the library, you can achieve the same functionality in Axios which isn't readable & reusable

const response = await axios.get('http://example.com/api/v1/products?page=2&paginate=25&search=we');
console.log(response.data);

Pros:

After using this library, you can achieve the same functionality of Axios in a readable & reusable way

const response = await datatable.get('products');
console.log(response.data);

Usage

To get started with Datatable Axios, follow these simple steps:

import axios from "axios"

// Make the axios library globally available on the window object
window.axios = axios
// Set your base API URL for seamless requests
window.axios.defaults.baseURL = "http://example.com/api/v1/"

// Other configuration here 

Import the package at the top of your JavaScript file:

import datatable from 'datatable-axios'

Initialize an instance of the Datatable class:

const datatable = new Datatable();

Use of API URL

When you have a global axios.js configuration setting with baseURL, simplify calls API by using just the path:

const response = await datatable.get('products');
console.log(response.data);

If you're not utilizing a global axios.js configuration for with baseURL, include the full URL when making API calls:

const response = await datatable.get('http://example.com/api/v1/products');
console.log(response.data);

Use of HTTP Requests

Perform different types of HTTP requests with Datatable Axios:

Perform a GET request:

const response = await datatable.get('url or path');
console.log(response.data); // Display the fetched data

Perform a POST request:

const response = await datatable.post('url or path');
console.log(response.data); // Display the response data

Perform a PUT request:

const response = await datatable.put('url or path');
console.log(response.data); // Display the updated data

Example of HTTP Call

Example 1:

datatable.get('http://example.com/api/v1/products')
.then(response => {
  console.log("Data fetched successfully:", response.data);
})
.catch(error => {
  console.error("An error occurred:", error);
});

Example 2:

try {
  const response = await datatable.get('/api/v1/products');
  console.log("Data fetched successfully:", response.data);
} catch (error) {
  console.error("An error occurred:", error);
}

Contributing

We welcome contributions to enhance Datatable Axios! Feel free to open issues for bug reports or feature requests. If you'd like to contribute code, please fork the repository, make your changes, and submit a pull request.

License

Released under MIT License by @mahmudunnabikajal.