UNPKG

@types/rewire

Version:
47 lines (40 loc) 1.94 kB
# Installation > `npm install --save @types/rewire` # Summary This package contains type definitions for rewire (https://github.com/jhnns/rewire). # Details Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rewire. ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rewire/index.d.ts) ````ts declare namespace RewireInterfaces { interface RewiredModule { /** * Takes all enumerable keys of obj as variable names and sets the values respectively. Returns a function which can be called to revert the change. */ __set__(obj: { [variable: string]: any }): () => void; /** * Sets the internal variable name to the given value. Returns a function which can be called to revert the change. */ __set__(name: string, value: any): () => void; /** * Returns the private variable with the given name. */ __get__<T = any>(name: string): T; /** * Returns a function which - when being called - sets obj, executes the given callback and reverts obj. If callback returns a promise, obj is only reverted after * the promise has been resolved or rejected. For your convenience the returned function passes the received promise through. */ __with__(obj: { [variable: string]: any }): (callback: () => any) => any; } } /** * Returns a rewired version of the module found at filename. Use rewire() exactly like require(). */ declare function rewire<T = { [key: string]: any }>(filename: string): RewireInterfaces.RewiredModule & T; export = rewire; ```` ### Additional Details * Last updated: Tue, 07 Nov 2023 15:11:36 GMT * Dependencies: none # Credits These definitions were written by [Borislav Zhivkov](https://github.com/borislavjivkov), and [Federico Caselli](https://github.com/CaselIT).