0.3.3 • Published 9 years ago

browser-request v0.3.3

Weekly downloads
240,343
License
-
Repository
github
Last release
9 years ago

Browser Request: The easiest HTTP library you'll ever see

Browser Request is a port of Mikeal Rogers's ubiquitous and excellent request package to the browser.

Jealous of Node.js? Pining for clever callbacks? Request is for you.

Don't care about Node.js? Looking for less tedium and a no-nonsense API? Request is for you too.

browser support

Examples

Fetch a resource:

request('/some/resource.txt', function(er, response, body) {
  if(er)
    throw er;
  console.log("I got: " + body);
})

Send a resource:

request.put({uri:'/some/resource.xml', body:'<foo><bar/></foo>'}, function(er, response) {
  if(er)
    throw new Error("XML PUT failed (" + er + "): HTTP status was " + response.status);
  console.log("Stored the XML");
})

To work with JSON, set options.json to true. Request will set the Content-Type and Accept headers, and handle parsing and serialization.

request({method:'POST', url:'/db', body:'{"relaxed":true}', json:true}, on_response)

function on_response(er, response, body) {
  if(er)
    throw er
  if(result.ok)
    console.log('Server ok, id = ' + result.id)
}

Or, use this shorthand version (pass data into the json option directly):

request({method:'POST', url:'/db', json:{relaxed:true}}, on_response)

Convenient CouchDB

Browser Request provides a CouchDB wrapper. It is the same as the JSON wrapper, however it will indicate an error if the HTTP query was fine, but there was a problem at the database level. The most common example is 409 Conflict.

request.couch({method:'PUT', url:'/db/existing_doc', body:{"will_conflict":"you bet!"}}, function(er, resp, result) {
  if(er.error === 'conflict')
    return console.error("Couch said no: " + er.reason); // Output: Couch said no: Document update conflict.

  if(er)
    throw er;

  console.log("Existing doc stored. This must have been the first run.");
})

See the Node.js Request README for several more examples. Request intends to maintain feature parity with Node request (except what the browser disallows). If you find a discrepancy, please submit a bug report. Thanks!

Usage

Browserify

Browser Request is a browserify-enabled package.

First, add browser-request to your Node project

$ npm install browser-request

Next, make a module that uses the package.

// example.js - Example front-end (client-side) code using browser-request via browserify
//
var request = require('browser-request')
request('/', function(er, res) {
  if(!er)
    return console.log('browser-request got your root path:\n' + res.body)

  console.log('There was an error, but at least browser-request loaded and ran!')
  throw er
})

To build this for the browser, run it through browserify.

$ browserify --entry example.js --outfile example-built.js

Deploy example-built.js to your web site and use it from your page.

  <script src="example-built.js"></script> <!-- Runs the request, outputs the result to the console -->

UMD

browser-request is UMD wrapped, allowing you to serve it directly to the browser from wherever you store the module.

  <script src="/node_modules/browser-request/index.js"></script> <!-- Assigns the module to window.request -->

You may also use an AMD loader by referencing the same file in your loader config.

License

Browser Request is licensed under the Apache 2.0 license.

@newgo2/api@ngs/mercury-parser@ccf-test/ccf-web@paul_wieland_repo/ccf-web@smallstack/frontend-web@infinitebrahmanuniverse/nolb-browser-@everything-registry/sub-chunk-1266node-jsdomnode-localwiki-clientmws-simple-browsernarratornarrator2node-red-contrib-coinbaseminiswaggermuzzley-clientmercadolivremeloticmeteor-react-ssr-jsdom@v2land/mercury-parser@yac/dashboardaltcoin-explorersaa-shop-client-libadministrate@zalastax/nolb-browser-awesome-auth-clientavogadro-mercury-parserbeagle-altmetrics@alohahealth/matrix-react-sdkapiology-fork-asana@2nthony/postlight-parser@2klic/2klic_io-sdkapi-requestappearin-sdkbinder-webbioweb3beyondcore-explorersbft-tendermintbenchdbasync-databitcore-explorers-bitcore-lib-0.13.19bitcore-explorers-mincobitcore-explorers-upbitcore-insightbitcore-litecoinbitcore-explorersbitcore-wallet-client-colxbitcore-wallet-client-mycoinblockchainjsblockcypher-unofficialcloudant-followconfiguration-backofficecopay-libbrowser-node-slackbrowser-refreshbsproofbrowser-googlbtcnano-explorers@biocad/biocad@biocad/jfwbrinkbit.jsbrowser-binance-apibitpay-public-clientbitpay-push-notification-clientnpm-recommendernode-xmpp-clientnode-xmpp-client-legacynode-xmpp-client-tmpnode-xmpp-client-virtusnode-xmpp-tmpnode-xmppclient-boshnxt-apinode-ses-browseronex-parserraml-semantic-uiorchestra-clientopenmoticsjsoslc-clientosrm-clientpoloniex-api-jsreact-material-boiler-appreact-image-publisheropenpublish-stateparalleldots-clientreact-openpublish-docreact-openpublish-iframereact-railsperformanceplatform-client.jspinboard.jsphuzzy.linksendingnetwork-js-sdkser-nodevehicle-machrxmpp-libuber-formvaprpcvoxel-async-simulationvox-webcompilervremotingvericredtransparencia
0.3.3

9 years ago

0.3.2

10 years ago

0.3.1

10 years ago

0.3.0

10 years ago

0.2.1

11 years ago

0.2.0

12 years ago

0.1.0

12 years ago

0.1.0-beta2

12 years ago

0.1.0-beta1

12 years ago