Skip to content

Require a package, if it doesn't exists you can define a default value that will be return

License

Notifications You must be signed in to change notification settings

jpiazzal/require-if

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

require-if

Require a package, if it doesn't exists you can define a default value that will be return.

If package doesn't exist it will never throw an error.

Getting Started

Installation

Install the package in your project as dependency (add option --save-dev if you want it as devDependencies)

npm install require-if

Usage

const requireIf = require("require-if");

// Default value that will be return if the package doesn't exist
const defaultValueOfThePackage = {
    add: () => (0)
};
const somePackage = requireIf("some-package", defaultValueOfThePackage);

// If package exist
console.log(somePackage.add(1, 2)); // 3
// OR
// If package doesn't exist
console.log(somePackage.add(1, 2)); // 0

The second paramater is optionnal, if you don't add it it will return an empty object.

const requireIf = require("require-if");

const somePackage = requireIf("some-package");

// If package doesn't exist
console.log(somePackage); // {}

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

About

Require a package, if it doesn't exists you can define a default value that will be return

Resources

License

Stars

Watchers

Forks

Packages

No packages published