An open API service indexing awesome lists of open source software.

https://github.com/silverwind/globalrequire

INACTIVE - please use https://github.com/sindresorhus/import-global
https://github.com/silverwind/globalrequire

Last synced: 12 months ago
JSON representation

INACTIVE - please use https://github.com/sindresorhus/import-global

Awesome Lists containing this project

README

          

# globalrequire
[![](https://img.shields.io/npm/v/globalrequire.svg?style=flat)](https://www.npmjs.org/package/globalrequire) [![](https://img.shields.io/npm/dm/globalrequire.svg)](https://www.npmjs.org/package/globalrequire) [![](https://api.travis-ci.org/silverwind/globalrequire.svg?style=flat)](https://travis-ci.org/silverwind/globalrequire)
> require() globally installed modules

`globalrequire` is like `require` but for globally installed modules. Supports both [yarn](https://github.com/yarnpkg/yarn) and [npm](https://github.com/npm/npm)'s global locations, with a preference for yarn when in conflict. Will not attempt to do any fallback to local modules or `NODE_PATH`.

## Installation
```console
$ npm i --save globalrequire
```
## Example
```js
const globalrequire = require('globalrequire');

console.log(globalrequire('npm').version);
//=> '3.10.9'

console.log(globalrequire.resolve('npm'));
//=> '/Users/silverwind/.npm-global/lib/node_modules/npm'
```

## API
### globalrequire(module)
### globalrequire.resolve(module)
- `module` *String* - The module name. Will throw on invalid module names or relative requests.

© [silverwind](https://github.com/silverwind), distributed under BSD licence