# XMLHttpRequest Envelope

[![NPM version][npm-version-image]][npm-url]
[![Build Status][build-status-image]][build-status-url]
[![Coverage Status][coverage-image]][coverage-url]
[![Known Vulnerabilities][vulnerabilities-image]][vulnerabilities-url]
[![Dependencies][dependencies-image]][dependencies-url]
[![Downloads][npm-downloads-image]][npm-url]
[![Install Size][install-size-image]][install-size-url]
[![Contributors][contributors-image]][contributors-url]
[![Pull Requests Welcome][pull-requests-image]][pull-requests-url]

A wrapper for XMLHttpRequest to allow for simpler RESTful API transactions.

## Client-Side Usage

```html
<script src="xhr-envelope.js"></script>

<script type="text/javascript">
	envelope.setBaseUrl("http://127.0.0.1:3000");

	envelope.get(
		"status",
		function(error, result) {
			if(error) {
				return console.error(error);
			}

			return console.log(result);
		}
	);
</script>
```

## Installation

To install this module:
```bash
npm install xhr-envelope
```

## Building

To build the distribution files for this module:
```bash
npm run build
```
or
```bash
gulp build
```

[npm-url]: https://www.npmjs.com/package/xhr-envelope
[npm-version-image]: https://img.shields.io/npm/v/xhr-envelope.svg
[npm-downloads-image]: http://img.shields.io/npm/dm/xhr-envelope.svg

[build-status-url]: https://travis-ci.org/nitro404/xhr-envelope
[build-status-image]: https://travis-ci.org/nitro404/xhr-envelope.svg?branch=master

[coverage-url]: https://coveralls.io/github/nitro404/xhr-envelope?branch=master
[coverage-image]: https://coveralls.io/repos/github/nitro404/xhr-envelope/badge.svg?branch=master

[vulnerabilities-url]: https://snyk.io/test/github/nitro404/xhr-envelope?targetFile=package.json
[vulnerabilities-image]: https://snyk.io/test/github/nitro404/xhr-envelope/badge.svg?targetFile=package.json

[dependencies-url]: https://david-dm.org/nitro404/xhr-envelope
[dependencies-image]: https://img.shields.io/david/nitro404/xhr-envelope.svg

[install-size-url]: https://packagephobia.now.sh/result?p=xhr-envelope
[install-size-image]: https://badgen.net/packagephobia/install/xhr-envelope

[contributors-url]: https://github.com/nitro404/xhr-envelope/graphs/contributors
[contributors-image]: https://img.shields.io/github/contributors/nitro404/xhr-envelope.svg

[pull-requests-url]: https://github.com/nitro404/xhr-envelope/pulls
[pull-requests-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg