README
HTTPRequest v0.0.1
A simple yet powerful HTTP request library inspired by jQuery and LSL written in Javascript for clientside and Serverside(Node.js) Javascript. Major thanks to node-XMLHttpRequest for giving us a XMLHttpRequest Object, that really helps make this both client/server.
Setup
To set up HTTPRequest on your Node.js server use npm(case sensitive package name).
npm install HTTPRequest
If you want to use HTTPRequest on the client-side (browser), just include HTTPRequest.js into your page.
<script type='text/javascript' src='HTTPRequest.js'></script>
Example
First, you have to do is require the HTTPRequest module (if you're using it client-side, this isn't necessary).
var HTTPRequest = require('HTTPRequest');
HTTPRequest.get('get_test.php', function(status, headers, content)
{
console.log(status, headers, content);
});
request
request(url, parameters, callback)
A lower level function, but I hope you never really need to use it as post
, get
is a wrapper around it.
post
post(url, data, callback, options)
A url, data(object, can be empty also {}
), callback are required.
options is not required, but it can be a object.
get
get(url, callback, options)
url and callback are required.
options is not required, but it can be a object.
delete
del(url, callback, options)
same as get
put
put(url, data, callback, options)
same as post
encode
encode(url)
takes a url and escapes it, then returns it.
decode
encode(url)
takes a decodeed url and Unencode's it, then returns it.
options
*option names are NOT case sensitive.
USERAGENT
- string - Write your own user agent, default isnode.js
. Setting this ONLY works on the server.QUERY
-string
orobject
- appends to the end of theurl
.DATA
-'POST'
or'PUT'
datastring
orobject
parameters
Everything as options, but also:
METHOD
- string - 'GET'
, 'POST'
, 'PUT'
and 'DELETE'
, default is 'GET'
callback
status, headers, content
status
- is HTTP code (like 404 or 200)headers
- is a object with the respone headerscontent
- The metadata `