Adding deprecated jsdoc for camelCaseKeys.camelCaseKeys

launchdarkly · Sep 29, 2020 · 0a453f3 · 0a453f3
1 parent e24f2c9
commit 0a453f3
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/utils.ts b/src/utils.ts
@@ -48,7 +48,11 @@ export const getFlattenedFlagsFromChangeset = (
   return flattened;
 };
 
-// TODO: Remove this for the next major version. This was added to maintain backwards compatibility.
+/**
+ * @deprecated The `camelCaseKeys.camelCaseKeys` property will be removed in a future version,
+ * please update your code to use the `camelCaseKeys` function directly.
+ */
+// tslint:disable-next-line deprecation
 camelCaseKeys.camelCaseKeys = camelCaseKeys;
 
 export default { camelCaseKeys, getFlattenedFlagsFromChangeset };