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