Skip to content

Commit

Permalink
modify doc
Browse files Browse the repository at this point in the history
  • Loading branch information
nuintun committed May 20, 2015
1 parent 9798660 commit 7fc7261
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 25 deletions.
24 changes: 0 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,30 +93,6 @@ var stream = Send.use(request); // The Send.use return a new send stream

The `pipe` method is used to pipe the response into the Node.js HTTP response object, typically `Send.use(req).pipe(res)`.

### stream.url

Return the normalize request url.

### stream.request

Return the http request.

### stream.response

Return the http response.

### stream.redirect(url)

Redirect url, if header already send, do nothing.

### stream.error(status, [error])
Emit http error, if header already send will end the response with error message and status.

### stream.send(path, stat)

The basic interface, send a file stream to response no filter.
If it is not necessary to do not use.

## Error-handling

By default when no `error` listeners are present an automatic response will be made, otherwise you have full control over the response, aka you may show a 5xx page etc.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "file-send",
"version": "0.1.0",
"version": "0.1.1",
"description": "A http file send",
"author": {
"name": "Nuintun",
Expand Down

0 comments on commit 7fc7261

Please sign in to comment.