@astral/mobx-query 1.0.1 → 1.2.0

package/MobxQuery/MobxQuery.d.ts

@@ -21,7 +21,7 @@ type CreateInfiniteQueryParams<TResult, TError> = Omit<InfiniteQueryParams<TResu
 /**
  * @description Сервис, позволяющий кэшировать данные.
  */
-export declare class MobxQuery {
+export declare class MobxQuery<TDefaultError = void> {
     /**
      * @description объект соответствия хешей ключей и их значений
      */
@@ -58,6 +58,10 @@ export declare class MobxQuery {
      * предполагается использование из домена
      */
     invalidate: (keysParts: CacheKey[]) => void;
+    /**
+     * @description метод инвалидации всех query
+     */
+    invalidateQueries: () => void;
     /**
      * @description метод, который занимается проверкой наличия стора по ключу,
      * и если нет, создает новый, добавляет его к себе в память, и возвращает его пользователю
@@ -66,14 +70,14 @@ export declare class MobxQuery {
     /**
      * @description метод создания стора, кешируется
      */
-    createQuery: <TResult, TError>(key: CacheKey[], executor: QueryExecutor<TResult>, params?: CreateQueryParams<TResult, TError> | undefined) => Query<TResult, TError>;
+    createQuery: <TResult, TError = TDefaultError>(key: CacheKey[], executor: QueryExecutor<TResult>, params?: CreateQueryParams<TResult, TError> | undefined) => Query<TResult, TError>;
     /**
      * @description метод создания инфинит стора, кешируется
      */
-    createInfiniteQuery: <TResult, TError>(key: CacheKey[], executor: InfiniteExecutor<TResult>, params?: CreateInfiniteQueryParams<TResult, TError> | undefined) => InfiniteQuery<TResult, TError>;
+    createInfiniteQuery: <TResult, TError = TDefaultError>(key: CacheKey[], executor: InfiniteExecutor<TResult>, params?: CreateInfiniteQueryParams<TResult, TError> | undefined) => InfiniteQuery<TResult, TError>;
     /**
      * @description метод создания мутации, не кешируется
      */
-    createMutation: <TResult, TError, TExecutorParams>(executor: MutationExecutor<TResult, TExecutorParams>, params?: MutationParams<TResult, TError> | undefined) => Mutation<TResult, TError, TExecutorParams>;
+    createMutation: <TResult, TError = TDefaultError, TExecutorParams = void>(executor: MutationExecutor<TResult, TExecutorParams>, params?: MutationParams<TResult, TError> | undefined) => Mutation<TResult, TError, TExecutorParams>;
 }
 export {};

package/MobxQuery/MobxQuery.js

@@ -45,6 +45,14 @@ export class MobxQuery {
                 }
             });
         };
+        /**
+         * @description метод инвалидации всех query
+         */
+        this.invalidateQueries = () => {
+            [...this.cacheableStores.entries()].forEach(([, store]) => {
+                store.invalidate();
+            });
+        };
         /**
          * @description метод, который занимается проверкой наличия стора по ключу,
          * и если нет, создает новый, добавляет его к себе в память, и возвращает его пользователю

package/README.md

@@ -174,6 +174,12 @@ mobxQuery.invalidate(['key one']); // ключ не совпадает, query Н
 
 - Инвалидация будет происходить только для query, поле `data` которых считывается в данный момент. Для query, `data` которых будут отрендерены позже, запрос произойдет только в момент использования. Для превентивного обновления данных потребуется последовательное использование `sync/async` методов сразу после `invalidate`.
 
+### Массовая инвалидация
+Для инвалидации всех query необходимо использовать метод `invalidateQueries`
+```ts
+mobxQuery.invalidateQueries();
+```
+
 # InfiniteQuery
 Существует необходимость постепенного запроса массивов данных, в постраничном режиме. Типичный пример, инфинити скролл, когда новая пачка данных запрашивается, в момент когда пользователь докрутил список до конца.
 Для удобства, мы создали специальный `query`, который содержит дополнительный метод `fetchMore` и при вызове оного, происходит запрос с увеличенными счетчиками. Данные ответа на этот запрос, будут сконкатенированы с уже имеющимся. В случае, если количество данных меньше, чем длина страницы, будет считаться что мы дошли до конца списка.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astral/mobx-query",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "browser": "./index.js",
   "main": "./index.js",
   "dependencies": {

package/types.d.ts

@@ -46,6 +46,6 @@ export type FetchPolicy = 'network-only' | 'cache-first';
 /**
  * @description ключ для кешированя
  */
-export type CacheKey = string | string[] | number | {
+export type CacheKey = string | number | boolean | null | undefined | CacheKey[] | {
     [key: string]: CacheKey;
 };