Create cold-years-itch.md

latticexyz · Sep 14, 2023 · b479643 · b479643
1 parent 70880a7
commit b479643
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/.changeset/cold-years-itch.md b/.changeset/cold-years-itch.md
@@ -0,0 +1,24 @@
+---
+"@latticexyz/cli": major
+"@latticexyz/protocol-parser": major
+"@latticexyz/store-sync": major
+"@latticexyz/store": major
+---
+
+Renamed all occurrences of `schema` where it is used as "value schema" to `valueSchema` to clearly distinguish it from "key schema".
+The only breaking change for users is the change from `schema` to `valueSchema` in `mud.config.ts`.
+
+```diff
+// mud.config.ts
+export default mudConfig({
+  tables: {
+    CounterTable: {
+      keySchema: {},
+-     schema: {
++     valueSchema: {
+        value: "uint32",
+      },
+    },
+  }
+}
+```