mirror of
https://github.com/shimataro/ssh-key-action.git
synced 2025-06-19 22:52:10 +10:00
* first action! (#1)
This commit is contained in:
parent
8deacc95b1
commit
ace1e6a69a
3750 changed files with 1155519 additions and 0 deletions
77
node_modules/responselike/README.md
generated
vendored
Normal file
77
node_modules/responselike/README.md
generated
vendored
Normal file
|
@ -0,0 +1,77 @@
|
|||
# responselike
|
||||
|
||||
> A response-like object for mocking a Node.js HTTP response stream
|
||||
|
||||
[](https://travis-ci.org/lukechilds/responselike)
|
||||
[](https://coveralls.io/github/lukechilds/responselike?branch=master)
|
||||
[](https://www.npmjs.com/package/responselike)
|
||||
[](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
|
Loading…
Add table
Add a link
Reference in a new issue