comunicationLeap/node_modules/xmlhttprequest/README.md
node_modules/xmlhttprequest/README.mdRaw
1# node-XMLHttpRequest #
2
3node-XMLHttpRequest is a wrapper for the built-in http client to emulate the
4browser XMLHttpRequest object.
5
6This can be used with JS designed for browsers to improve reuse of code and
7allow the use of existing libraries.
8
9Note: This library currently conforms to [XMLHttpRequest 1](http://www.w3.org/TR/XMLHttpRequest/). Version 2.0 will target [XMLHttpRequest Level 2](http://www.w3.org/TR/XMLHttpRequest2/).
10
11## Usage ##
12
13Here's how to include the module in your project and use as the browser-based
14XHR object.
15
16 var XMLHttpRequest = require("xmlhttprequest").XMLHttpRequest;
17 var xhr = new XMLHttpRequest();
18
19Note: use the lowercase string "xmlhttprequest" in your require(). On
20case-sensitive systems (eg Linux) using uppercase letters won't work.
21
22## Versions ##
23
24Prior to 1.4.0 version numbers were arbitrary. From 1.4.0 on they conform to
25the standard major.minor.bugfix. 1.x shouldn't necessarily be considered
26stable just because it's above 0.x.
27
28Since the XMLHttpRequest API is stable this library's API is stable as
29well. Major version numbers indicate significant core code changes.
30Minor versions indicate minor core code changes or better conformity to
31the W3C spec.
32
33## License ##
34
35MIT license. See LICENSE for full details.
36
37## Supports ##
38
39* Async and synchronous requests
40* GET, POST, PUT, and DELETE requests
41* All spec methods (open, send, abort, getRequestHeader,
42 getAllRequestHeaders, event methods)
43* Requests to all domains
44
45## Known Issues / Missing Features ##
46
47For a list of open issues or to report your own visit the [github issues
48page](https://github.com/driverdan/node-XMLHttpRequest/issues).
49
50* Local file access may have unexpected results for non-UTF8 files
51* Synchronous requests don't set headers properly
52* Synchronous requests freeze node while waiting for response (But that's what you want, right? Stick with async!).
53* Some events are missing, such as abort
54* getRequestHeader is case-sensitive
55* Cookies aren't persisted between requests
56* Missing XML support
57* Missing basic auth