self-review: fix asserts, add examples to documentation, add document…

…ation examples to tests

src/core/serialize.js

@@ -1,7 +1,7 @@
-/* eslint-disable no-console */
 import { invariant, isPrimitive } from "../utils/utils"
 import getDefaultModelSchema from "../api/getDefaultModelSchema"
 import { SKIP, _defaultPrimitiveProp } from "../constants"
+
 /**
  * Serializes an object (graph) into json using the provided model schema.
  * The model schema can be omitted if the object type has a default model schema associated with it.
@@ -36,7 +36,7 @@ export default function serialize(arg1, arg2) {
 }
 
 export function checkStarSchemaInvariant(propDef) {
-    invariant(propDef === true || propDef.pattern, `prop schema '*' can only be used with 'true': ${JSON.stringify(propDef)}`)
+    invariant(propDef === true || propDef.pattern, `prop schema '*' can only be used with 'true' or a prop def with a 'pattern': ${JSON.stringify(propDef)}`)
 }
 
 export function serializeWithSchema(schema, obj) {

src/core/serializeAll.js

@@ -5,7 +5,8 @@ import setDefaultModelSchema from "../api/setDefaultModelSchema"
 import object from "../types/object"
 
 /**
- * The `serializeAll` decorator can be used on a class to signal that all primitive properties should be serialized automatically.
+ * The `serializeAll` decorator can may used on a class to signal that all primitive properties,
+ * or complex properties with a name matching a `pattern`, should be serialized automatically.
  *
  * @example
  * @serializeAll class Store {
@@ -16,7 +17,23 @@ import object from "../types/object"
  * const store = new Store();
  * store.c = 5;
  * store.d = {};
- * t.deepEqual(serialize(store), { a: 3, b: undefined, c: 5 });
+ * t.deepEqual(serialize(store), { c: 5 });
+ *
+ * @example
+ * class DataType {
+ *     @serializable
+ *     x;
+ *     @serializable
+ *     y;
+ * }
+ * @serializeAll(/^[a-z]$/, DataType) class ComplexStore {
+ * }
+ *
+ * const store = new ComplexStore();
+ * store.a = {x: 1, y: 2};
+ * store.b = {};
+ * store.somethingElse = 5;
+ * t.deepEqual(serialize(store), { a: {x: 1, y: 2}, b: { x: undefined, y: undefined } });
  */
 export default function serializeAll(targetOrPattern, clazzOrSchema) {
     let propSchema;

test/typescript/ts.ts

@@ -641,3 +641,32 @@ test("[ts] @serializeAll(list schema)", t => {
 
     t.end()
 })
+
+test("[ts] tests from serializeAll documentation", t => {
+    @serializeAll class Store {
+        [key: string]: number;
+    }
+
+    const store = new Store();
+    store.c = 5;
+    (store as any).d = {};
+    t.deepEqual(serialize(store), { c: 5 });
+
+    class DataType {
+        @serializable
+        x?: number;
+        @serializable(optional())
+        y?: number;
+    }
+    @serializeAll(/^[a-z]$/, DataType) class ComplexStore {
+        [key: string]: DataType;
+    }
+
+    const complexStore = new ComplexStore();
+    complexStore.a = {x: 1, y: 2};
+    complexStore.b = {};
+    (complexStore as any).somethingElse = 5;
+    t.deepEqual(serialize(complexStore), { a: {x: 1, y: 2}, b: { x: undefined } });
+
+    t.end();
+})