Skip to content

Commit

Permalink
feat: thenable/is
Browse files Browse the repository at this point in the history
  • Loading branch information
medikoo committed Apr 4, 2019
1 parent 91cf5e5 commit 2711d70
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,24 @@ ensureRegExp("foo"); // Thrown TypeError: null is not a regular expression objec

---

#### Thenable

The JavaScript _thenable_ object (an object with `then` method)

##### `thenable/is`

Confirms if given object is a _thenable_

```javascript
const isThenable = require("type/thenable/is");

isThenable(Promise.resolve()); // true
isThenable({ then: () => {} }); // true
isThenable({}); // false
```

---

### Error

The JavaScript _Error_ instance
Expand Down
39 changes: 39 additions & 0 deletions test/thenable/is.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
"use strict";

var assert = require("chai").assert
, isThenable = require("../../thenable/is");

describe("thenable/is", function () {
it("Should return true on object with `then` method", function () {
assert.equal(isThenable({ then: function () { return true; } }), true);
});
it("Should return false on object with `then` non callable property", function () {
assert.equal(isThenable({ then: {} }), false);
});

it("Should return false on plain object", function () { assert.equal(isThenable({}), false); });
it("Should return false on function", function () {
assert.equal(isThenable(function () { return true; }), false);
});
it("Should return false on array", function () { assert.equal(isThenable([]), false); });
if (typeof Object.create === "function") {
it("Should return false on object with no prototype", function () {
assert.equal(isThenable(Object.create(null)), false);
});
}
it("Should return false on string", function () { assert.equal(isThenable("foo"), false); });
it("Should return false on empty string", function () { assert.equal(isThenable(""), false); });
it("Should return false on number", function () { assert.equal(isThenable(123), false); });
it("Should return false on NaN", function () { assert.equal(isThenable(NaN), false); });
it("Should return false on boolean", function () { assert.equal(isThenable(true), false); });
if (typeof Symbol === "function") {
it("Should return false on symbol", function () {
assert.equal(isThenable(Symbol("foo")), false);
});
}

it("Should return false on null", function () { assert.equal(isThenable(null), false); });
it("Should return false on undefined", function () {
assert.equal(isThenable(void 0), false);
});
});
9 changes: 9 additions & 0 deletions thenable/is.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
"use strict";

var isObject = require("../object/is");

module.exports = function (value) {
if (!isObject(value)) return false;
try { return typeof value.then === "function"; }
catch (error) { return false; }
};

0 comments on commit 2711d70

Please sign in to comment.