@cycjimmy/mini-xhr
v8.0.0
Published
A very lightweight javascript library for HTTP requests.
Readme
Mini XHR
A very lightweight javascript library for HTTP requests.
Install
# via npm
$ npm install @cycjimmy/mini-xhr --save
# or via yarn
$ yarn add @cycjimmy/mini-xhrUsage
import miniXhr from '@cycjimmy/mini-xhr'
miniXhr.get('/getData')
.then((data) => {
// handle data
})
.catch((err) => {
console.error(err) // handle error
})Module format
Since v8 the package is ESM only: main, module and exports (import / default) all point to dist/mini-xhr.esm.js, while dist/mini-xhr.umd.min.js is still published for <script> tags and CDNs (it exposes the miniXhr global).
The CommonJS artifact (dist/mini-xhr.cjs), the require export condition and the package.cjs shim were removed, so require('@cycjimmy/mini-xhr') no longer resolves. From CommonJS, load it with a dynamic import (top-level await is not available there); from a classic script, use the UMD bundle below:
import('@cycjimmy/mini-xhr')
.then(({ default: miniXhr }) => {
// use miniXhr here
})
.catch(console.error)The build targets ES2015, so the previous ES5/IE transpilation guarantees are gone.
miniXhr supports the following methods:
miniXhr.get(url, [,settings])
url: [Require][String] The server URL that will be used for the request.- The
settingssupports: [Option][Object]params: [Option][Object] The key-value pair for the URL parameters to be sent with the request. Default{}.responseType: [Option][String] The type of data that the server will respond with. Choose one of the options:'arraybuffer''document''json'(default)'text''stream''blob'
headers: [Option][Object] The key-value pair that custom headers to be sent. Default{}.contentType: [Option][String] Content type. Default'application/json; charset=UTF-8'.timeout: [Option][Number] The number of milliseconds before the request times out. A value of 0 means there will be no timeout. Default0.ontimeoutCB: [Option][Function] The time-out callback function. Defaultnull.
miniXhr.post(url, [,settings])
url: [Require][String] The server URL that will be used for the request.- The
settingssupports: [Option][Object]params: [Option][Object] The key-value pair for the URL parameters to be sent with the request. Default{}.data: [Option][Object|FormData|String] The data to be sent as the request body. Default{}.dataType: [Option][String] The type of the data to be sent as the request body. Choose one of the options:'json'(default)'formData''text'
responseType: [Option][String] The type of data that the server will respond with. Choose one of the options:'arraybuffer''document''json'(default)'text''stream''blob'
headers: [Option][Object] The key-value pair that custom headers to be sent. Default{}.contentType: [Option][String] Content type. Default'application/json; charset=UTF-8'.timeout: [Option][Number] The number of milliseconds before the request times out. A value of 0 means there will be no timeout. Default0.ontimeoutCB: [Option][Function] The time-out callback function. Defaultnull.
miniXhr.jsonp(url, [,settings])
url: [Require][String] The server URL that will be used for the request.- The
settingssupports: [Option][Object]params: [Option][Object] The key-value pair for the URL parameters to be sent with the request. Default{}.timeout: [Option][Number] The number of milliseconds before the request times out. A value of 0 means there will be no timeout. Default5000.
Handling Errors
GET or POST
miniXhr.get('/getData')
.then((data) => {
// data handle
})
.catch((err) => {
console.log(err.statusText) // the text of the response status
console.log(err.status) // the numerical HTTP status code
})JSONP
miniXhr.jsonp('/getData')
.then((data) => {
// data handle
})
.catch((err) => {
console.log(err) // return 'error' or 'timeout'
})Use in browser: E.g.
<script src="mini-xhr.umd.min.js"></script>
<script>
miniXhr.jsonp('/getData', {
params: {
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@8/dist/mini-xhr.umd.min.js"></script>