3.21.0 • Published 5 years ago

argsbytype

Licence

MIT

Version

3.21.0

Deps

Size

24 kB

Vulns

Weekly

Stars

Summary Dependency Versions

Arguments By Type

Provide some arguments, get back a hash object of the arguments indexed by their type. Very useful for agnostic argument orders.

Usage

Let's say your coding a function, and you want to accept arguments in any order. Traditionally this would look like:

https://github.com/bevry/argsbytype/blob/master/example/01.js

But what happens when you:

Start having arguments that are regular expressions or dates which typeof is still object instead of regexp or date
Or, when you start having multiple arguments of the same type, that you would like to accept (e.g. the first string should be the name property, the second string should be the keyword property)

At that point in time, it becomes too much trouble to bother with. Fortunately, argsbytype is to the rescue! Now you can do:

https://github.com/bevry/argsbytype/blob/master/example/02.js

Yay! Big win for agnostic argument order! But when would you actually want this? Well, it turns out that in CoffeeScript options come first, in JavaScript, options usually come last. By using this, we can support both conventions, for example:

https://github.com/bevry/argsbytype/blob/master/example/03.js

Install

npm

Install: npm install --save argsbytype
Import: import * as pkg from ('argsbytype')
Require: const pkg = require('argsbytype')

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/argsbytype@3.21.0'
</script>

Editions

This package is published with the following editions:

argsbytype aliases argsbytype/source/index.js
argsbytype/source/index.js is ESNext source code for Node.js 10 || 12 || 14 || 15 with Require for modules
argsbytype/edition-browsers/index.js is ESNext compiled for web browsers with Require for modules