fix(deprecate): Make deprecate accept conditional argument (#488)

bustle · Sep 6, 2016 · 059fd66 · 059fd66
1 parent 68a60ae
commit 059fd66
Showing 1 changed file with 13 additions and 2 deletions.
diff --git a/src/js/utils/deprecate.js b/src/js/utils/deprecate.js
@@ -1,3 +1,14 @@
-export default function deprecate(message) {
-  console.log(`[mobiledoc-kit] [DEPRECATED]: ${message}`); // jshint ignore:line
+/**
+ * Usage:
+ * Without a conditional, always prints deprecate message:
+ *   `deprecate('This is deprecated')`
+ *
+ * Conditional deprecation, works similarly to `assert`, prints deprecation if
+ * conditional is false:
+ *   `deprecate('Deprecated only if foo !== bar', foo === bar)`
+ */
+export default function deprecate(message, conditional=false) {
+  if (!conditional) {
+    console.log(`[mobiledoc-kit] [DEPRECATED]: ${message}`); // jshint ignore:line
+  }
 }