This library is tested against the following platforms.
Keep in mind that the versions above are not hard requirements.
The preferred installation method is to add the library to the
section in your
npm can be used to install the library directly.
npm install xhr2
Once the library is installed,
require-ing it returns the
var XMLHttpRequest = ;
The other objects that are usually defined in an XHR environment are hanging
var XMLHttpRequestUpload = XMLHttpRequestXMLHttpRequestUpload;
MDN (the Mozilla Developer Network) has a great intro to XMLHttpRequest.
This library's CoffeeDocs can be used as quick reference to the XMLHttpRequest specification parts that were implemented.
The following standard features are implemented.
send()accepts the following data types: String, ArrayBufferView, ArrayBuffer (deprecated in the standard)
readystatechangeand download progress events
The following node.js extensions are implemented.
send()accepts a node.js Buffer
bufferproduces a node.js Buffer
nodejsSetdoes XHR network configuration that is not exposed in browsers, for security reasons
The following standard features are not implemented.
The library aims to implement the W3C XMLHttpRequest specification, so the library's API will always be a (hopefully growing) subset of the API in the specification.
The following commands will get the source tree in a
node-xhr2/ directory and
build the library.
git clone git://github.com/pwnall/node-xhr2.gitcd node-xhr2npm installnpm pack
Installing CoffeeScript globally will let you type
cake instead of
npm install -g coffee-script
The library comes with unit tests that exercise the XMLHttpRequest API.
The tests themselves can be tested by running them in a browser environment, where a different XMLHttpRequest implementation is available. Both Google Chrome and Firefox deviate from the specification in small ways, so it's best to run the tests in both browsers and mentally compute an intersection of the failing tests.
cake webtestBROWSER=firefox cake webtest
The library is Copyright (c) 2013 Victor Costan, and distributed under the MIT License.