Oxg, simple ajax library

Oxg is a very simple ajax library with readable api and cross browser support.

Installation

By yarn

yarn add oxg

By npm

npm install oxg

Or by script file

<script src="oxg.js"></script>

Of course you can install oxg by cdns
unpkg

<script src="https://unpkg.com/[email protected]/dist/oxg.min.js"></script>

jsDelivr

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/oxg.min.js"></script>

Bundle.run

<script src="https://bundle.run/[email protected]"></script>

Works with webpack, parcel and etc.

Usage, simple get request

var oxg = require('oxg');

oxg.get('/about')
    .then(response => {
        console.log(response);
    });

Tip: oxg comes with headers like XMLHttpRequest, so you don't have to define which header you had to use in order to make the right request.

Post requests

var oxg = require('oxg');

oxg.post('/about', {
        email: '[email protected]'
    })
    .then(response => {
        console.log(response);
    });

Optional params

loading()

Sometimes ajax requests my take time due to slow server, due to slow internet connection and etc. For those reasons you will to need to show user some type of message so they can realize that requests loads. For triggering any functions when ajax request loads, you can use loading method.

    oxg.post('/about', {
        email: '[email protected]'
    })
    .loading(() => {
        // do whatever you want to do here while ajax loads, 
        // loaders and etc..
        console.log('Waiting for ajax request to be finished');
    })
    .then(response => {
        console.log(
        'Ajax request has finished and got response: ' + response
        );
    });

Some old browser like IE 8 are caching files that has been already requested. Even if that file has been changed, IE 8 will still load old file in which it might be bad. To disable cache, we can add method cache() and assign false value to it

oxg.get('file.txt')
    .cache(false)
    .then(response => {
        // ajax request has been complete, do whatever you want to do here
        console.log(
        'Ajax request has finished and got response: ' + response
        );
    });

Tip: if you request a .json or .xml file, oxg will return a parsed version of the file

Oxg Instance

If you assign a variable to oxg, it will return oxg instance, which can be useful to determine the data about ajax request, like: ajax response, ajax timeout and others

let oxgInstance = oxg.post('/to', {
        name: 'Nurmuhammet Ali',
        email: '[email protected]',
    }).then(response => {
        console.log(response);
    });

console.log(oxgInstance);

Please, don't hesitate to open an issue.

Contact mail: [email protected]

License

The oxg is open-sourced software licensed under the MIT license.