@types/proxyquire

What is @types/proxyquire?

@types/proxyquire provides TypeScript type definitions for the proxyquire library, which is used for overriding dependencies during testing. This allows you to mock or stub dependencies in your unit tests, making it easier to isolate the code under test.

What are @types/proxyquire's main functionalities?

Mocking Dependencies

This feature allows you to mock dependencies of a module. In the example, the './dependency' module's 'myFunction' is replaced with a mock implementation that returns 'mocked value'.

const proxyquire = require('proxyquire');
const myModule = proxyquire('./myModule', {
  './dependency': { myFunction: () => 'mocked value' }
});
console.log(myModule()); // Outputs: 'mocked value'

Stubbing Dependencies

This feature allows you to stub dependencies of a module. In the example, the './dependency' module's 'myFunction' is replaced with a stub implementation that returns 'stubbed value'.

const proxyquire = require('proxyquire');
const stub = { myFunction: () => 'stubbed value' };
const myModule = proxyquire('./myModule', { './dependency': stub });
console.log(myModule()); // Outputs: 'stubbed value'

Conditional Mocking

This feature allows you to conditionally mock dependencies based on certain conditions, such as environment variables. In the example, the './dependency' module is mocked only if the NODE_ENV environment variable is set to 'test'.

const proxyquire = require('proxyquire');
const myModule = proxyquire('./myModule', {
  './dependency': process.env.NODE_ENV === 'test' ? { myFunction: () => 'mocked value' } : require('./dependency')
});
console.log(myModule()); // Outputs: 'mocked value' if NODE_ENV is 'test', otherwise the real implementation

Other packages similar to @types/proxyquire

sinon

Sinon is a popular library for creating spies, stubs, and mocks in JavaScript. It provides more granular control over individual functions and is often used in conjunction with other testing frameworks. Unlike proxyquire, which focuses on overriding entire modules, Sinon is more focused on individual function behavior.

rewire

Rewire is another library that allows you to modify the behavior of modules during testing. It provides a similar functionality to proxyquire but with a different API. Rewire allows you to set and get private variables within a module, which can be useful for more fine-grained control.

mock-require

Mock-require is a simpler alternative to proxyquire that allows you to mock Node.js modules. It provides a straightforward API for replacing modules with mock implementations. While it lacks some of the advanced features of proxyquire, it is easier to use for simple use cases.

README

Installation

npm install --save @types/proxyquire

Summary

This package contains type definitions for proxyquire (https://github.com/thlorenz/proxyquire).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/proxyquire.

index.d.ts

declare var p: Proxyquire;
export = p;

interface Proxyquire {
    (request: string, stubs: any): any;
    <T>(request: string, stubs: any): T;

    load(request: string, stubs: any): any;
    load<T>(request: string, stubs: any): T;

    noCallThru(): Proxyquire;
    callThru(): Proxyquire;

    noPreserveCache(): Proxyquire;
    preserveCache(): Proxyquire;
}

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by jt000.