@nodifier/http-mock

A node module to mock http/https requests made for unit testing etc. Suitable for unit testing framework like Jest.

How to use?

import { justMock } from '@nodify/http-mock';

describe('some unit tests', () => {
    it('should mock the request', async () => {
        const jm = justMock('http://example.com/api').get(200).response('hello world')

        // Your node request function that you wish to mock the request
        const output = await makeRequest();

        jm.done();

        expect(output).toStrictEqual('hello world');
    })
})

Specify the endpoint to mock

// The endpoint to mock
jestMock('http://example.com/api')

Mocking the response status code

You can mock the response from any of the request methods available. view

// response status code to mock as a response
get(200)

Mocking the response body

The response body can be mock by using the response method as follows:

// Will return "hello world" as the request response
response('hello world');

Ending mock

The mock always have to be ended with done method when the unit test is done like follows...

const jm = justMock('http://example.com/api').get(200).response('hello world')

const output = await makeRequest();

// Ends the mock
jm.done();

expect(output).toBeTruthy();

Supported request methods

1. GET
2. POST
3. PUT
4. DELETE

GET

justMock('http://example.com/api').get(200)

POST

justMock('http://example.com/api').post(200)

PUT

justMock('http://example.com/api').put(200)

DELETE

justMock('http://example.com/api').del(200)