feat: Object.ensurePlainFunction

medikoo · Mar 16, 2018 · 2682be6 · 2682be6
1 parent c4e07e6
commit 2682be6
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/object/ensure-plain-function.js b/object/ensure-plain-function.js
@@ -0,0 +1,11 @@
+"use strict";
+
+var safeToString    = require("../safe-to-string")
+  , isPlainFunction = require("./is-plain-function");
+
+module.exports = function (value) {
+	if (!isPlainFunction(value)) {
+		throw new TypeError(safeToString(value) + " is not a plain function");
+	}
+	return value;
+};
diff --git a/object/index.js b/object/index.js
@@ -15,6 +15,7 @@ module.exports = {
 	ensureInteger: require("./ensure-integer"),
 	ensureNaturalNumber: require("./ensure-natural-number"),
 	ensureNaturalNumberValue: require("./ensure-natural-number-value"),
+	ensurePlainFunction: require("./ensure-plain-function"),
 	ensurePromise: require("./ensure-promise"),
 	eq: require("./eq"),
 	every: require("./every"),

diff --git a/test/object/ensure-plain-function.js b/test/object/ensure-plain-function.js
@@ -0,0 +1,14 @@
+"use strict";
+
+module.exports = function (t, a) {
+	// Just sanity checks, as logic is tested at isPlainFunction
+	var fn = function () {};
+	a(t(fn), fn, "Function");
+	a.throws(
+		function () {
+			t({});
+		},
+		TypeError,
+		"Error"
+	);
+};