# override-require

> Overrides Node.js module resolution logic.

Latest version **1.1.1** (published 2016-11-10) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install override-require
pnpm add override-require
yarn add override-require
bun add override-require
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2016-11-10 |
| First published | 2016-09-10 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gajus Kuizinas |
| Maintainers | gajus |
| Keywords | override, require, module |

## Links

- npm: https://www.npmjs.com/package/override-require
- Repository: https://github.com/gajus/override-require
- Homepage: https://github.com/gajus/override-require#readme
- Issues: https://github.com/gajus/override-require/issues
- npm.io page: https://npm.io/package/override-require

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2016-11-10
- 1.1.0 — 2016-09-10

## README

# override-require

[![Travis build status](http://img.shields.io/travis/gajus/override-require/master.svg?style=flat-square)](https://travis-ci.org/gajus/override-require)
[![Coveralls](https://img.shields.io/coveralls/gajus/override-require.svg?style=flat-square)](https://github.com/gajus/override-require)
[![NPM version](http://img.shields.io/npm/v/override-require.svg?style=flat-square)](https://www.npmjs.org/package/override-require)
[![Canonical Code Style](https://img.shields.io/badge/code%20style-canonical-blue.svg?style=flat-square)](https://github.com/gajus/canonical)

Overrides Node.js module resolution logic.

## Usage

```js
import overrideRequire from 'override-require';

// Setup a callback used to determine whether a specific `require` invocation
// needs to be overridden.
const isOverride = (request: string, parent: Object): boolean => {};

// Setup a callback used to handle an overridden `require` invocation.
const resolveRequest = (request: string, parent: Object): any => {};

const restoreOriginalModuleLoader = overrideRequire(isOverride, resolveRequest);

// Restore the original module loader.
restoreOriginalModuleLoader();
```

## Example

```js
import overrideRequire from 'override-require';

const isOverride = (request) => {
  return request === 'vm';
};

const resolveRequest = (request) => {
  return 'test';
};

const restoreOriginalModuleLoader = restoreOriginalRequire(isOverride, resolveRequest);

require('vm');
// string 'test'

require('events');
// class EventEmitter

restoreOriginalModuleLoader();

require('vm');
// object vm
```

---
_Source: https://npm.io/package/override-require · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._