aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@sinonjs/commons/lib/deprecated.js
diff options
context:
space:
mode:
authorJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
committerJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
commit080c5819d87b933816d724a83f3bf4f1686770a7 (patch)
tree4a2ccc68b27edf7d4cbc586c932cc7542b655e19 /node_modules/@sinonjs/commons/lib/deprecated.js
parent5ac7049a9d30733165cc212dee308163c2a14644 (diff)
parentd003b82235a9329f912522a2f70aa950dfce4998 (diff)
downloadLYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.tar.gz
LYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.zip
Merge branch 'master' of https://github.com/JoelHMikael/FoodJS
Updating remote changes
Diffstat (limited to 'node_modules/@sinonjs/commons/lib/deprecated.js')
-rw-r--r--node_modules/@sinonjs/commons/lib/deprecated.js58
1 files changed, 58 insertions, 0 deletions
diff --git a/node_modules/@sinonjs/commons/lib/deprecated.js b/node_modules/@sinonjs/commons/lib/deprecated.js
new file mode 100644
index 0000000..ad68cc9
--- /dev/null
+++ b/node_modules/@sinonjs/commons/lib/deprecated.js
@@ -0,0 +1,58 @@
+/* eslint-disable no-console */
+"use strict";
+
+/**
+ * Returns a function that will invoke the supplied function and print a
+ * deprecation warning to the console each time it is called.
+ *
+ * @param {Function} func
+ * @param {string} msg
+ * @returns {Function}
+ */
+exports.wrap = function(func, msg) {
+ var wrapped = function() {
+ exports.printWarning(msg);
+ return func.apply(this, arguments);
+ };
+ if (func.prototype) {
+ wrapped.prototype = func.prototype;
+ }
+ return wrapped;
+};
+
+/**
+ * Returns a string which can be supplied to `wrap()` to notify the user that a
+ * particular part of the sinon API has been deprecated.
+ *
+ * @param {string} packageName
+ * @param {string} funcName
+ * @returns {string}
+ */
+exports.defaultMsg = function(packageName, funcName) {
+ return (
+ packageName +
+ "." +
+ funcName +
+ " is deprecated and will be removed from the public API in a future version of " +
+ packageName +
+ "."
+ );
+};
+
+/**
+ * Prints a warning on the console, when it exists
+ *
+ * @param {string} msg
+ * @returns {undefined}
+ */
+exports.printWarning = function(msg) {
+ /* istanbul ignore next */
+ if (typeof process === "object" && process.emitWarning) {
+ // Emit Warnings in Node
+ process.emitWarning(msg);
+ } else if (console.info) {
+ console.info(msg);
+ } else {
+ console.log(msg);
+ }
+};