@astral/mobx-query 1.18.0 → 1.18.1

package/README.md

@@ -31,6 +31,7 @@
     - [Создание mutations](#создание-и-использование-mutations)
     - [Синхронный вызов mutation](#синхронный-вызов-mutation)
     - [Асинхронный вызов mutation](#асинхронный-вызов-mutation)
+    - [Best practices для MutationSet](#best-practices-для-mutationset)
   - [Кэширование QuerySet и InfiniteQuerySet](#кэширование-queryset-и-infinitequeryset)
     - [FetchPolicy](#fetchpolicy)
     - [Как работает кэш](#как-работает-кэш)
@@ -428,6 +429,36 @@ const editDocMutation = docsFetcher.mutations.editDoc.create();
 await editDocMutation.async({ params: { id: 'docID', name: 'test' } });
 ```
 
+### Best practices для MutationSet
+
+#### `Mutation` должен создаваться в конструкторе класса, а не в getter
+
+**✅ Valid**
+
+```ts
+class DocStore {
+  private readonly creationDocMutation: Mutation<DocsDTO.CreateDocResponse, DocsDTO.CreateDocInput>;
+
+  public constructor(
+    private readonly _docsFetcher: DocsFetcher,
+  ) {
+    this.creationDocMutation = this._docsFetcher.mutations.createDoc.create();
+  }
+}
+```
+
+**❌ Invalid**
+
+```ts
+class DocStore {
+  private get creationDocMutation() {
+    return this._docsFetcher.mutations.createDoc.create();
+  }
+}
+```
+
+Описанный кейс является антипаттерном потому что если на `creationDocMutation` больше не будет подписчиков, то при следующем обращении getter заново создаст `mutation`. Это может привести к нежелательным побочным эффектам.
+
 ## Кэширование QuerySet и InfiniteQuerySet
 
 `QuerySet` и `InfiniteQuerySet` позволяет закэшировать данные, которые были получены ранее.

package/package.json

@@ -10,7 +10,7 @@
   "peerDependencies": {
     "mobx": "^6.0.0"
   },
-  "version": "1.18.0",
+  "version": "1.18.1",
   "author": "Astral.Soft",
   "license": "MIT",
   "repository": {