https://github.com/sindresorhus/responselike

A response-like object for mocking a Node.js HTTP response stream
https://github.com/sindresorhus/responselike

http https mock request response

Last synced: about 1 month ago
JSON representation

A response-like object for mocking a Node.js HTTP response stream

• Host: GitHub
• URL: https://github.com/sindresorhus/responselike
• Owner: sindresorhus
• License: mit
• Created: 2017-06-19T11:28:14.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-12-16T16:03:40.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T10:50:06.269Z (7 months ago)
• Topics: http, https, mock, request, response
• Language: JavaScript
• Homepage:
• Size: 23.4 KB
• Stars: 37
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

README

        
# responselike

> A response-like object for mocking a Node.js HTTP response stream

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

```sh

npm install responselike

```

## Usage

```js

import Response from 'responselike';

const response = new Response({

	statusCode: 200,

	headers: {

		foo: 'bar'

	},

	body: Buffer.from('Hi!'),

	url: 'https://example.com'

});

response.statusCode;

// 200

response.headers;

// {foo: 'bar'}

response.body;

// 

response.url;

// 'https://example.com'

response.pipe(process.stdout);

// 'Hi!'

```

## API

### new Response(options?)

Returns a streamable response object similar to a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage).

#### options

Type: `object`

##### statusCode

Type: `number`

The HTTP response status code.

##### headers

Type: `object`

The HTTP headers. Keys will be automatically lowercased.

##### body

Type: `Buffer`

The response body. The Buffer contents will be streamable but is also exposed directly as `response.body`.

##### url

Type: `string`

The request URL string.