https://github.com/fengb/require-optional
Require optional modules in node
https://github.com/fengb/require-optional
Last synced: about 1 year ago
JSON representation
Require optional modules in node
- Host: GitHub
- URL: https://github.com/fengb/require-optional
- Owner: fengb
- Created: 2015-01-29T02:16:55.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-09-15T00:17:16.000Z (over 9 years ago)
- Last Synced: 2024-05-01T21:39:07.299Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# require-optional [![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
## Usage
Install via npm:
```bash
$ npm install require-optional
```
Basic usage:
```javascript
var requireOptional = require('require-optional')
var optDep = requireOptional('dep')
if (optDep) {
/* do stuff with optDep */
}
```
`require-optional` can return a default value:
```javascript
var optDep = requireOptional('dep', function () {})
optDep('processing')
```
`require-optional` accepts an error callback for when the module is not found:
```javascript
requireOptional('dep', null, function (err) {
console.warn(err)
})
```
`require-optional` can also require relative modules:
```javascript
var optDep = requireOptional('./dep')
```
[npm-image]: https://img.shields.io/npm/v/require-optional.svg?style=flat
[npm-url]: https://npmjs.org/package/require-optional
[travis-image]: https://img.shields.io/travis/fengb/require-optional.svg?style=flat
[travis-url]: https://travis-ci.org/fengb/require-optional