No Description

Sven Slootweg 320f842e94 1.0.0 4 years ago
src fc6593ec93 Initial commit 4 years ago
.gitignore fc6593ec93 Initial commit 4 years ago
.npmignore fc6593ec93 Initial commit 4 years ago
CHANGELOG.md 14e0ba51d6 Add documentation and changelog 4 years ago
README.md 14e0ba51d6 Add documentation and changelog 4 years ago
gulpfile.js fc6593ec93 Initial commit 4 years ago
index.js fc6593ec93 Initial commit 4 years ago
package.json 320f842e94 1.0.0 4 years ago

README.md

assure-array

Wraps a value in an array if it isn't already one. Returns an empty array for null and undefined.

A typical usecase for this: when you have an option that accepts multiple values as an array, but you want to make the use of an array literal optional when there's only a single value to specify.

License

WTFPL or CC0, whichever you prefer. A donation and/or attribution are appreciated, but not required.

Donate

Maintaining open-source projects takes a lot of time, and the more donations I receive, the more time I can dedicate to open-source. If this module is useful to you, consider making a donation!

You can donate using Bitcoin, PayPal, Flattr, cash-in-mail, SEPA transfers, and pretty much anything else. Thank you!

Contributing

Pull requests welcome. Please make sure your modifications are in line with the overall code style, and ensure that you're editing the files in src/, not those in lib/.

Build tool of choice is gulp; simply run gulp while developing, and it will watch for changes.

Be aware that by making a pull request, you agree to release your modifications under the licenses stated above.

Usage

Some examples:

var assureArray = require("assure-array");

assureArray("hello world");      // ["hello world!"]
assureArray(["hello", "world"]); // ["hello", "world"]
assureArray(null);               // []
assureArray([true]);             // [true]

API

assureArray(value)

Ensures that the provided value is returned as an array.

  • If value is an array already, this returns the array unchanged.
  • If value is null or undefined, this returns an empty array.
  • If value is any other kind of value, this returns a new array containing just that one value.