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