@common.js/mimic-fn 4.0.0

package/README.md

@@ -0,0 +1,5 @@
+# @common.js/mimic-fn
+
+The [mimic-fn](https://www.npmjs.com/package/mimic-fn) package exported as CommonJS modules.
+
+Exported from [mimic-fn@4.0.0](https://www.npmjs.com/package/mimic-fn/v/4.0.0) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -0,0 +1,52 @@
+export interface Options {
+	/**
+	Skip modifying [non-configurable properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor#Description) instead of throwing an error.
+
+	@default false
+	*/
+	readonly ignoreNonConfigurable?: boolean;
+}
+
+/**
+Modifies the `to` function to mimic the `from` function. Returns the `to` function.
+
+`name`, `displayName`, and any other properties of `from` are copied. The `length` property is not copied. Prototype, class, and inherited properties are copied.
+
+`to.toString()` will return the same as `from.toString()` but prepended with a `Wrapped with to()` comment.
+
+@param to - Mimicking function.
+@param from - Function to mimic.
+@returns The modified `to` function.
+
+@example
+```
+import mimicFunction from 'mimic-fn';
+
+function foo() {}
+foo.unicorn = '🦄';
+
+function wrapper() {
+	return foo();
+}
+
+console.log(wrapper.name);
+//=> 'wrapper'
+
+mimicFunction(wrapper, foo);
+
+console.log(wrapper.name);
+//=> 'foo'
+
+console.log(wrapper.unicorn);
+//=> '🦄'
+```
+*/
+export default function mimicFunction<
+	ArgumentsType extends unknown[],
+	ReturnType,
+	FunctionType extends (...arguments: ArgumentsType) => ReturnType
+>(
+	to: (...arguments: ArgumentsType) => ReturnType,
+	from: FunctionType,
+	options?: Options,
+): FunctionType;

package/index.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return mimicFunction;
+    }
+});
+function _defineProperty(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _objectSpread(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
+        }
+        ownKeys.forEach(function(key) {
+            _defineProperty(target, key, source[key]);
+        });
+    }
+    return target;
+}
+function ownKeys(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        if (enumerableOnly) {
+            symbols = symbols.filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+            });
+        }
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
+}
+function _objectSpreadProps(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) {
+        Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+        ownKeys(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
+}
+var copyProperty = function(to, from, property, ignoreNonConfigurable) {
+    // `Function#length` should reflect the parameters of `to` not `from` since we keep its body.
+    // `Function#prototype` is non-writable and non-configurable so can never be modified.
+    if (property === "length" || property === "prototype") {
+        return;
+    }
+    // `Function#arguments` and `Function#caller` should not be copied. They were reported to be present in `Reflect.ownKeys` for some devices in React Native (#41), so we explicitly ignore them here.
+    if (property === "arguments" || property === "caller") {
+        return;
+    }
+    var toDescriptor = Object.getOwnPropertyDescriptor(to, property);
+    var fromDescriptor = Object.getOwnPropertyDescriptor(from, property);
+    if (!canCopyProperty(toDescriptor, fromDescriptor) && ignoreNonConfigurable) {
+        return;
+    }
+    Object.defineProperty(to, property, fromDescriptor);
+};
+// `Object.defineProperty()` throws if the property exists, is not configurable and either:
+// - one its descriptors is changed
+// - it is non-writable and its value is changed
+var canCopyProperty = function canCopyProperty(toDescriptor, fromDescriptor) {
+    return toDescriptor === undefined || toDescriptor.configurable || toDescriptor.writable === fromDescriptor.writable && toDescriptor.enumerable === fromDescriptor.enumerable && toDescriptor.configurable === fromDescriptor.configurable && (toDescriptor.writable || toDescriptor.value === fromDescriptor.value);
+};
+var changePrototype = function(to, from) {
+    var fromPrototype = Object.getPrototypeOf(from);
+    if (fromPrototype === Object.getPrototypeOf(to)) {
+        return;
+    }
+    Object.setPrototypeOf(to, fromPrototype);
+};
+var wrappedToString = function(withName, fromBody) {
+    return "/* Wrapped ".concat(withName, "*/\n").concat(fromBody);
+};
+var toStringDescriptor = Object.getOwnPropertyDescriptor(Function.prototype, "toString");
+var toStringName = Object.getOwnPropertyDescriptor(Function.prototype.toString, "name");
+// We call `from.toString()` early (not lazily) to ensure `from` can be garbage collected.
+// We use `bind()` instead of a closure for the same reason.
+// Calling `from.toString()` early also allows caching it in case `to.toString()` is called several times.
+var changeToString = function(to, from, name) {
+    var withName = name === "" ? "" : "with ".concat(name.trim(), "() ");
+    var newToString = wrappedToString.bind(null, withName, from.toString());
+    // Ensure `to.toString.toString` is non-enumerable and has the same `same`
+    Object.defineProperty(newToString, "name", toStringName);
+    Object.defineProperty(to, "toString", _objectSpreadProps(_objectSpread({}, toStringDescriptor), {
+        value: newToString
+    }));
+};
+function mimicFunction(to, from) {
+    var ref = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : {}, _ignoreNonConfigurable = ref.ignoreNonConfigurable, ignoreNonConfigurable = _ignoreNonConfigurable === void 0 ? false : _ignoreNonConfigurable;
+    var name = to.name;
+    var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+    try {
+        for(var _iterator = Reflect.ownKeys(from)[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+            var property = _step.value;
+            copyProperty(to, from, property, ignoreNonConfigurable);
+        }
+    } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                _iterator.return();
+            }
+        } finally{
+            if (_didIteratorError) {
+                throw _iteratorError;
+            }
+        }
+    }
+    changePrototype(to, from);
+    changeToString(to, from, name);
+    return to;
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@common.js/mimic-fn",
+  "version": "4.0.0",
+  "description": "Make a function mimic another one",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "devDependencies": {
+    "ava": "^3.15.0",
+    "tsd": "^0.14.0",
+    "xo": "^0.38.2"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "dependencies": {},
+  "main": "./index.js"
+}

package/readme.md

@@ -0,0 +1,90 @@
+<img src="media/logo.svg" alt="mimic-fn" width="400">
+<br>
+
+> Make a function mimic another one
+
+Useful when you wrap a function in another function and like to preserve the original name and other properties.
+
+## Install
+
+```
+$ npm install mimic-fn
+```
+
+## Usage
+
+```js
+import mimicFunction from 'mimic-fn';
+
+function foo() {}
+foo.unicorn = '🦄';
+
+function wrapper() {
+	return foo();
+}
+
+console.log(wrapper.name);
+//=> 'wrapper'
+
+mimicFunction(wrapper, foo);
+
+console.log(wrapper.name);
+//=> 'foo'
+
+console.log(wrapper.unicorn);
+//=> '🦄'
+
+console.log(String(wrapper));
+//=> '/* Wrapped with wrapper() */\nfunction foo() {}'
+```
+
+
+## API
+
+### mimicFunction(to, from, options?)
+
+Modifies the `to` function to mimic the `from` function. Returns the `to` function.
+
+`name`, `displayName`, and any other properties of `from` are copied. The `length` property is not copied. Prototype, class, and inherited properties are copied.
+
+`to.toString()` will return the same as `from.toString()` but prepended with a `Wrapped with to()` comment.
+
+#### to
+
+Type: `Function`
+
+Mimicking function.
+
+#### from
+
+Type: `Function`
+
+Function to mimic.
+
+#### options
+
+Type: `object`
+
+##### ignoreNonConfigurable
+
+Type: `boolean`\
+Default: `false`
+
+Skip modifying [non-configurable properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor#Description) instead of throwing an error.
+
+## Related
+
+- [rename-fn](https://github.com/sindresorhus/rename-fn) - Rename a function
+- [keep-func-props](https://github.com/ehmicky/keep-func-props) - Wrap a function without changing its name and other properties
+
+---
+
+<div align="center">
+	<b>
+		<a href="https://tidelift.com/subscription/pkg/npm-mimic-fn?utm_source=npm-mimic-fn&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+	</b>
+	<br>
+	<sub>
+		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+	</sub>
+</div>