noargs-wrapper 1.0.0

package/README.md

@@ -0,0 +1,37 @@
+# noargs-wrapper
+
+Returns a wrapper that calls a function with no arguments.
+
+## Installation
+
+```bash
+$ npm install noargs-wrapper
+```
+
+## Usage
+
+This function takes in a function, and returns a wrapper that calls the passed-in function with no arguments, even if arguments are passed in to the wrapper. (unless the function passed in takes over 100 arguments)
+
+Here's an example:
+
+```js
+var noargs = require('noargs-wrapper');
+
+
+var isOne = v => v === 1; // a simple function to check if a value is one
+
+var wrappedIsOne = noargs(isOne);
+
+console.log(wrappedIsOne(1)); // always returns false because no arguments are passed in, and undefined is not one.
+
+
+var isUndefined = v => v === void 0; // a simple function to check if a value is undefined
+
+var wrappedIsUndefined = noargs(isUndefined);
+
+console.log(wrappedIsUndefined(1)); // always returns true because no arguments are passed in, so undefined is undefined, hence true
+```
+
+## Contributing
+
+PRs and issues are welcome on the github repository!

package/index.js

@@ -0,0 +1,21 @@
+const GetIntrinsic = require("get-intrinsic")
+const ignoreArgument = require("ignore-argument")
+const isFunction = require("is-function")
+
+const $Array = GetIntrinsic('%Array%')
+
+/**
+ * Wrap a function so it's always called with no arguments.
+ * @param {Function} fn - The function to wrap
+ * @returns {Function} - A new function that ignores all passed arguments
+ */
+function noArgsWrapper(fn) {
+  if (!isFunction(fn)) {
+    throw new TypeError("Expected a function")
+  }
+  const ignoreAll = $Array(100).fill(true)
+
+  return ignoreArgument(fn, ...ignoreAll)
+}
+
+module.exports = noArgsWrapper

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "noargs-wrapper",
+  "version": "1.0.0",
+  "description": "Wrap a function to always call it with no arguments, ignoring all arguments passed in.",
+  "keywords": [
+    "function",
+    "wrapper",
+    "arguments",
+    "utility",
+    "ignore",
+    "minimal"
+  ],
+  "homepage": "https://github.com/tj-commits/noargs-wrapper#readme",
+  "bugs": {
+    "url": "https://github.com/tj-commits/noargs-wrapper/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tj-commits/noargs-wrapper.git"
+  },
+  "license": "MIT",
+  "author": "me",
+  "type": "commonjs",
+  "main": "index.js",
+  "dependencies": {
+    "get-intrinsic": "^1.3.0",
+    "ignore-argument": "^0.1.1",
+    "is-function": "^1.0.2"
+  }
+}