diff options
Diffstat (limited to 'node_modules/responselike/README.md')
-rw-r--r-- | node_modules/responselike/README.md | 77 |
1 files changed, 0 insertions, 77 deletions
diff --git a/node_modules/responselike/README.md b/node_modules/responselike/README.md deleted file mode 100644 index 6361931..0000000 --- a/node_modules/responselike/README.md +++ /dev/null @@ -1,77 +0,0 @@ -# responselike - -> A response-like object for mocking a Node.js HTTP response stream - -[![Build Status](https://travis-ci.org/lukechilds/responselike.svg?branch=master)](https://travis-ci.org/lukechilds/responselike) -[![Coverage Status](https://coveralls.io/repos/github/lukechilds/responselike/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/responselike?branch=master) -[![npm](https://img.shields.io/npm/dm/responselike.svg)](https://www.npmjs.com/package/responselike) -[![npm](https://img.shields.io/npm/v/responselike.svg)](https://www.npmjs.com/package/responselike) - -Returns a streamable response object similar to a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage). Useful for formatting cached responses so they can be consumed by code expecting a real response. - -## Install - -```shell -npm install --save responselike -``` - -Or if you're just using for testing you'll want: - -```shell -npm install --save-dev responselike -``` - -## Usage - -```js -const Response = require('responselike'); - -const response = new Response(200, { foo: 'bar' }, Buffer.from('Hi!'), 'https://example.com'); - -response.statusCode; -// 200 -response.headers; -// { foo: 'bar' } -response.body; -// <Buffer 48 69 21> -response.url; -// 'https://example.com' - -response.pipe(process.stdout); -// Hi! -``` - - -## API - -### new Response(statusCode, headers, body, url) - -Returns a streamable response object similar to a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage). - -#### statusCode - -Type: `number` - -HTTP response status code. - -#### headers - -Type: `object` - -HTTP headers object. Keys will be automatically lowercased. - -#### body - -Type: `buffer` - -A Buffer containing the response body. The Buffer contents will be streamable but is also exposed directly as `response.body`. - -#### url - -Type: `string` - -Request URL string. - -## License - -MIT © Luke Childs |