feat: deprecate automatic type coercion from objects to strings

tediousjs · Sep 30, 2021 · 6ff0e1e · 6ff0e1e
1 parent 888cde1
commit 6ff0e1e
Show file tree

Hide file tree

Showing 7 changed files with 117 additions and 1 deletion.
diff --git a/src/data-types/char.ts b/src/data-types/char.ts
@@ -84,6 +84,8 @@ const Char: { maximumLength: number } & DataType = {
       if (typeof value.toString !== 'function') {
         throw new TypeError('Invalid string.');
       }
+
+      emitTypeCoercionWarning();
       value = value.toString();
     }
 
@@ -101,3 +103,18 @@ const Char: { maximumLength: number } & DataType = {
 
 export default Char;
 module.exports = Char;
+
+let typeCoercionWarningEmitted = false;
+function emitTypeCoercionWarning() {
+  if (typeCoercionWarningEmitted) {
+    return;
+  }
+
+  typeCoercionWarningEmitted = true;
+
+  process.emitWarning(
+    '`char` type coercion from non-string type value via `.toString()` method is deprecated and will be removed.',
+    'DeprecationWarning',
+    Char.validate
+  );
+}
diff --git a/src/data-types/nchar.ts b/src/data-types/nchar.ts
@@ -102,6 +102,8 @@ const NChar: DataType & { maximumLength: number } = {
       if (typeof value.toString !== 'function') {
         throw new TypeError('Invalid string.');
       }
+
+      emitTypeCoercionWarning();
       value = value.toString();
     }
     return value;
@@ -110,3 +112,18 @@ const NChar: DataType & { maximumLength: number } = {
 
 export default NChar;
 module.exports = NChar;
+
+let typeCoercionWarningEmitted = false;
+function emitTypeCoercionWarning() {
+  if (typeCoercionWarningEmitted) {
+    return;
+  }
+
+  typeCoercionWarningEmitted = true;
+
+  process.emitWarning(
+    '`nchar` type coercion from non-string type value via `.toString()` method is deprecated and will be removed.',
+    'DeprecationWarning',
+    NChar.validate
+  );
+}
diff --git a/src/data-types/ntext.ts b/src/data-types/ntext.ts
@@ -62,6 +62,8 @@ const NText: DataType = {
       if (typeof value.toString !== 'function') {
         throw new TypeError('Invalid string.');
       }
+
+      emitTypeCoercionWarning();
       value = value.toString();
     }
 
@@ -71,3 +73,18 @@ const NText: DataType = {
 
 export default NText;
 module.exports = NText;
+
+let typeCoercionWarningEmitted = false;
+function emitTypeCoercionWarning() {
+  if (typeCoercionWarningEmitted) {
+    return;
+  }
+
+  typeCoercionWarningEmitted = true;
+
+  process.emitWarning(
+    '`ntext` type coercion from non-string type value via `.toString()` method is deprecated and will be removed.',
+    'DeprecationWarning',
+    NText.validate
+  );
+}
diff --git a/src/data-types/nvarchar.ts b/src/data-types/nvarchar.ts
@@ -141,6 +141,8 @@ const NVarChar: { maximumLength: number } & DataType = {
       if (typeof value.toString !== 'function') {
         throw new TypeError('Invalid string.');
       }
+
+      emitTypeCoercionWarning();
       value = value.toString();
     }
     return value;
@@ -149,3 +151,18 @@ const NVarChar: { maximumLength: number } & DataType = {
 
 export default NVarChar;
 module.exports = NVarChar;
+
+let typeCoercionWarningEmitted = false;
+function emitTypeCoercionWarning() {
+  if (typeCoercionWarningEmitted) {
+    return;
+  }
+
+  typeCoercionWarningEmitted = true;
+
+  process.emitWarning(
+    '`nvarchar` type coercion from non-string type value via `.toString()` method is deprecated and will be removed.',
+    'DeprecationWarning',
+    NVarChar.validate
+  );
+}
diff --git a/src/data-types/text.ts b/src/data-types/text.ts
@@ -68,6 +68,8 @@ const Text: DataType = {
       if (typeof value.toString !== 'function') {
         throw new TypeError('Invalid string.');
       }
+
+      emitTypeCoercionWarning();
       value = value.toString();
     }
 
@@ -83,6 +85,20 @@ const Text: DataType = {
   }
 };
 
-
 export default Text;
 module.exports = Text;
+
+let typeCoercionWarningEmitted = false;
+function emitTypeCoercionWarning() {
+  if (typeCoercionWarningEmitted) {
+    return;
+  }
+
+  typeCoercionWarningEmitted = true;
+
+  process.emitWarning(
+    '`text` type coercion from non-string type value via `.toString()` method is deprecated and will be removed.',
+    'DeprecationWarning',
+    Text.validate
+  );
+}
diff --git a/src/data-types/uniqueidentifier.ts b/src/data-types/uniqueidentifier.ts
@@ -47,6 +47,7 @@ const UniqueIdentifier: DataType = {
         throw new TypeError('Invalid string.');
       }
 
+      emitTypeCoercionWarning();
       value = value.toString();
     }
 
@@ -60,3 +61,18 @@ const UniqueIdentifier: DataType = {
 
 export default UniqueIdentifier;
 module.exports = UniqueIdentifier;
+
+let typeCoercionWarningEmitted = false;
+function emitTypeCoercionWarning() {
+  if (typeCoercionWarningEmitted) {
+    return;
+  }
+
+  typeCoercionWarningEmitted = true;
+
+  process.emitWarning(
+    '`uniqueidentifier` type coercion from non-string type value via `.toString()` method is deprecated and will be removed.',
+    'DeprecationWarning',
+    UniqueIdentifier.validate
+  );
+}
diff --git a/src/data-types/varchar.ts b/src/data-types/varchar.ts
@@ -117,6 +117,7 @@ const VarChar: { maximumLength: number } & DataType = {
         throw new TypeError('Invalid string.');
       }
 
+      emitTypeCoercionWarning();
       value = value.toString();
     }
 
@@ -134,3 +135,18 @@ const VarChar: { maximumLength: number } & DataType = {
 
 export default VarChar;
 module.exports = VarChar;
+
+let typeCoercionWarningEmitted = false;
+function emitTypeCoercionWarning() {
+  if (typeCoercionWarningEmitted) {
+    return;
+  }
+
+  typeCoercionWarningEmitted = true;
+
+  process.emitWarning(
+    '`varchar` type coercion from non-string type value via `.toString()` method is deprecated and will be removed.',
+    'DeprecationWarning',
+    VarChar.validate
+  );
+}