https://github.com/timjacobi/required-argument

A function to mark function arguments as required
https://github.com/timjacobi/required-argument

Last synced: 11 months ago
JSON representation

A function to mark function arguments as required

• Host: GitHub
• URL: https://github.com/timjacobi/required-argument
• Owner: timjacobi
• Created: 2016-06-12T21:57:37.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-06-15T15:47:36.000Z (over 9 years ago)
• Last Synced: 2025-01-31T21:46:27.984Z (11 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/required-argument
• Size: 4.88 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# required-argument [![Build Status](https://travis-ci.org/timjacobi/required-argument.svg?branch=master)](https://travis-ci.org/timjacobi/required-argument)

Pass this function as a default argument to throw an error when the argument is `undefined`

## Example

```JavaScript

const required = require('required-argument');

function myFunc(a = required()){

  // do stuff

}

myFunc(); // Error: Missing argument in function "myfunc"

```

## Future

I'm experimenting with parsing the code to let you know which argument is missing but it's still not perfect yet. If you have any ideas on how to implement that or any other things you'd like to add please open an issue or PR.

## Credits

Inspired by [Six nifty ES6 tricks](http://www.2ality.com/2016/05/six-nifty-es6-tricks.html) by [@rauschma](https://github.com/rauschma)