Warn in toJS docs about deep cloning partial observables (#3239)

mobxjs · Jan 4, 2022 · bf5da6b · bf5da6b
1 parent f43ae70
commit bf5da6b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/.changeset/thin-adults-leave.md b/.changeset/thin-adults-leave.md
@@ -0,0 +1,5 @@
+---
+"mobx": patch
+---
+
+Improved `toJS` jsdoc
diff --git a/packages/mobx/src/api/tojs.ts b/packages/mobx/src/api/tojs.ts
@@ -62,7 +62,10 @@ function toJSHelper(source, __alreadySeen: Map<any, any>) {
 }
 
 /**
- * Basically, a deep clone, so that no reactive property will exist anymore.
+ * Recursively converts an observable to it's non-observable native counterpart.
+ * It does NOT recurse into non-observables, these are left as they are, even if they contain observables.
+ * Computed and other non-enumerable properties are completely ignored.
+ * Complex scenarios require custom solution, eg implementing `toJSON` or using `serializr` lib.
  */
 export function toJS<T>(source: T, options?: any): T {
     if (__DEV__ && options) die("toJS no longer supports options")