rexlucas / mini-xhr

XmlHttpRequest in promise

Mini XHR

Install

# via npm
$ npm install @cycjimmy/mini-xhr --save

# or via yarn
$ yarn add @cycjimmy/mini-xhr

Usage

import miniXhr from '@cycjimmy/mini-xhr';

# OR
const miniXhr = require('@cycjimmy/mini-xhr');

miniXhr.get(url [, settings])
  .then((data) => {
    // handle data
  });

miniXhr supports the following methods:

miniXhr.get(url, [, settings])

• url: [String] A string containing the URL to which the request is sent.
• settings:
  • data: [Object] The key-value pair that needs to be transmitted. Default {}.
  • dataType: [String] Request data type. Default 'json'.
  • contentType: [String] Setting content type. Default 'application/x-www-form-urlencoded; charset=UTF-8'.
  • timeout: [Number] Set a timeout for the request. A value of 0 means there will be no timeout. Default 0.
  • timeoutCB: [Function] Set the time-out callback function. Default null.

miniXhr.post(url, [, settings])

• url: [String] A string containing the URL to which the request is sent.
• settings:
  • data: [Object] The key-value pair that needs to be transmitted. Default {}.
  • dataType: [String] Request data type. Default 'json'.
  • contentType: [String] Setting content type. Default 'application/x-www-form-urlencoded; charset=UTF-8'.
  • timeout: [Number] Set a timeout for the request. A value of 0 means there will be no timeout. Default 0.
  • timeoutCB: [Function] Set the time-out callback function. Default null.

miniXhr.script(url, [, settings])

• url: [String] A string containing the URL to which the request is sent.
• settings:
  • data: [Object] The key-value pair that needs to be transmitted. Default {}.
  • timeout: [Number] Set a timeout for the request. A value of 0 means there will be no timeout. Default 0.

miniXhr.jsonp(url, [, settings])

• url: [String] A string containing the URL to which the request is sent.
• settings:
  • data: [Object] The key-value pair that needs to be transmitted. Default {}.
  • timeout: [Number] Set a timeout for the request. A value of 0 means there will be no timeout. Default 0.

Use in browser: E.g.

<script src="mini-xhr.umd.min.js"></script>
<script>
  miniXhr.jsonp('/getData' , {
    data: {
      key1: 'value1',
      key2: 'value2',
    }
  })
    .then(function(data) {
      // data handle
    });
</script>

CDN

To use via a CDN include this in your html:

<script src="https://cdn.jsdelivr.net/npm/@cycjimmy/mini-xhr@3/dist/mini-xhr.umd.min.js"></script>