Browse Source

v1.0.3: Documentation fix

pull/4/head
Sven Slootweg 7 years ago
parent
commit
752250a16b
  1. 3
      README.md
  2. 1
      lib/bhttp.coffee
  3. 2
      package.json

3
README.md

@ -49,6 +49,7 @@ Be aware that by making a pull request, you agree to release your modifications
A simple example:
```javascript
var Promise = require("bluebird");
var bhttp = require("bhttp");
Promise.try(function() {
@ -73,6 +74,7 @@ bhttp.get("http://icanhazip.com/", {}, function(err, response) {
Demonstrating both streaming responses and using a stream in form data for a request:
```javascript
var Promise = require("bluebird");
var bhttp = require("bhttp");
Promise.try(function() {
@ -107,6 +109,7 @@ bhttp.get("http://somesite.com/bigfile.mp4", {stream: true}, function(err, respo
### Sessions
```javascript
var Promise = require("bluebird");
var bhttp = require("bhttp");
var session = bhttp.session({ headers: {"user-agent": "MyCustomUserAgent/2.0"} });

1
lib/bhttp.coffee

@ -1,6 +1,7 @@
# FIXME: Force-lowercase user-supplied headers before merging them into the request?
# FIXME: Deep-merge query-string arguments between URL and argument?
# FIXME: Named arrays for multipart/form-data?
# FIXME: Are arrays of streams in `data` correctly recognized as being streams?
# Core modules
urlUtil = require "url"

2
package.json

@ -1,6 +1,6 @@
{
"name": "bhttp",
"version": "1.0.2",
"version": "1.0.3",
"description": "A sane HTTP client library for Node.js with Streams2 support.",
"main": "index.js",
"scripts": {

Loading…
Cancel
Save