Skip to content

Commit

Permalink
feat: array-like/ensure
Browse files Browse the repository at this point in the history
  • Loading branch information
medikoo committed Apr 4, 2019
1 parent fc5bb23 commit 45f1ddd
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,18 @@ isArrayLike("foo"); // false
isArrayLike("foo", { allowString: true }); // true
```

#### `array-like/ensure`

If given argument is an array like, it is returned back. Otherwise `TypeError` is thrown.

```javascript
const ensureArrayLike = require("type/array-like/ensure");

ensureArrayLike({ length: 0 }); // { length: 0 }
ensureArrayLike("foo", { allowString: true }); // "foo"
ensureArrayLike({}); // Thrown TypeError: null is not a regular expression object
```

---

#### Array length
Expand Down
9 changes: 9 additions & 0 deletions array-like/ensure.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
"use strict";

var resolveException = require("../lib/resolve-exception")
, is = require("./is");

module.exports = function (value/*, options*/) {
if (is(value, arguments[1])) return value;
return resolveException(value, "%v is not an array like value", arguments[1]);
};
24 changes: 24 additions & 0 deletions test/array-like/ensure.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
"use strict";

var assert = require("chai").assert
, ensureArrayLike = require("../../array-like/ensure");

describe("array-like/ensure", function () {
it("Should return input value", function () {
var value = [];
assert.equal(ensureArrayLike(value), value);
});
it("Should allow strings with allowString option", function () {
var value = "foo";
assert.equal(ensureArrayLike(value, { allowString: true }), value);
});
it("Should crash on invalid value", function () {
try {
ensureArrayLike("foo");
throw new Error("Unexpected");
} catch (error) {
assert.equal(error.name, "TypeError");
assert(error.message.includes("is not an array like value"));
}
});
});

0 comments on commit 45f1ddd

Please sign in to comment.