@astral/mobx-query 1.4.0 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@astral/mobx-query",
3
- "version": "1.4.0",
3
+ "version": "1.6.0",
4
4
  "browser": "./index.js",
5
5
  "main": "./index.js",
6
6
  "dependencies": {
package/types.d.ts CHANGED
@@ -4,36 +4,36 @@ export type SyncParams<TResult, TError, TExecutorParams = void> = {
4
4
  params?: TExecutorParams;
5
5
  };
6
6
  /**
7
- * @description синхронный метод получения данных
7
+ * синхронный метод получения данных
8
8
  */
9
9
  export type Sync<TResult, TError, TExecutorParams = void> = (params?: SyncParams<TResult, TError, TExecutorParams>) => void;
10
10
  /**
11
- * @description асинхронный метод получения данных
11
+ * асинхронный метод получения данных
12
12
  */
13
13
  export type Async<TResult, TExecutorParams = void> = (params: TExecutorParams) => Promise<TResult>;
14
14
  export type QueryBaseActions<TResult, TError, TExecutorParams = void> = {
15
15
  /**
16
- * @description синхронный метод получения данных
16
+ * синхронный метод получения данных
17
17
  */
18
18
  sync: Sync<TResult, TError, TExecutorParams>;
19
19
  /**
20
- * @description асинхронный метод получения данных
20
+ * асинхронный метод получения данных
21
21
  */
22
22
  async: Async<TResult, TExecutorParams>;
23
23
  /**
24
- * @description флаг обозначающий загрузку данных
24
+ * флаг обозначающий загрузку данных
25
25
  */
26
26
  isLoading: boolean;
27
27
  /**
28
- * @description флаг обозначающий, что последний запрос был зафейлен
28
+ * флаг обозначающий, что последний запрос был зафейлен
29
29
  */
30
30
  isError: boolean;
31
31
  /**
32
- * @description данные о последней ошибке
32
+ * данные о последней ошибке
33
33
  */
34
34
  error?: TError;
35
35
  /**
36
- * @description флаг обзначающий, что последний запрос был успешно выполнен
36
+ * флаг обзначающий, что последний запрос был успешно выполнен
37
37
  */
38
38
  isSuccess: boolean;
39
39
  /**
@@ -42,13 +42,13 @@ export type QueryBaseActions<TResult, TError, TExecutorParams = void> = {
42
42
  isIdle: boolean;
43
43
  };
44
44
  /**
45
- * @description политика получения данных.
46
- * @variation 'cache-first' - данные сначала берутся из кеша, если их нет, тогда идет обращение к сети, ответ записывается в кэш
47
- * @kind 'network-only' - данные всегда беруться из сети, при этом ответ записывается в кэш
45
+ * политика получения данных.
46
+ * @enum cache-first - данные сначала берутся из кеша, если их нет, тогда идет обращение к сети, ответ записывается в кэш
47
+ * @enum network-only - данные всегда берутся из сети, при этом ответ записывается в кэш
48
48
  */
49
49
  export type FetchPolicy = 'network-only' | 'cache-first';
50
50
  /**
51
- * @description ключ для кешированя
51
+ * ключ для кешированя
52
52
  */
53
53
  export type CacheKey = string | number | boolean | null | undefined | CacheKey[] | {
54
54
  [key: string]: CacheKey;