szdl-utils-kit 0.3.14 → 0.3.15
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/Readme.md +15 -12
- package/dist/index.js +1297 -951
- package/dist/index.umd.cjs +2 -2
- package/dist/types/batch.d.ts +59 -16
- package/dist/types/bx-boot.d.ts +3 -4
- package/package.json +44 -41
package/Readme.md
CHANGED
|
@@ -26,12 +26,15 @@ import {
|
|
|
26
26
|
### Batch
|
|
27
27
|
|
|
28
28
|
Утилита для пакетного выполнения запросов Bitrix24 с автоматической пагинацией, трекингом прогресса и обработкой ограничений.
|
|
29
|
-
|
|
29
|
+
Рекомендуется работать через `BxBoot`, а `Batch` использовать напрямую только при необходимости.
|
|
30
30
|
|
|
31
31
|
```ts
|
|
32
32
|
import { Batch } from "szdl-utils-kit";
|
|
33
33
|
|
|
34
|
-
const rest = new Batch(
|
|
34
|
+
const rest = new Batch({
|
|
35
|
+
callBatch: BX24.callBatch,
|
|
36
|
+
callMethod: BX24.callMethod,
|
|
37
|
+
});
|
|
35
38
|
const result = await rest.batch({
|
|
36
39
|
deals: { method: "crm.deal.list", params: { select: ["ID", "TITLE"] } },
|
|
37
40
|
users: { method: "user.get", params: { filter: { ACTIVE: "Y" } } },
|
|
@@ -39,6 +42,7 @@ const result = await rest.batch({
|
|
|
39
42
|
|
|
40
43
|
console.log(result.deals);
|
|
41
44
|
console.log(rest.errors); // ошибки по ключам
|
|
45
|
+
console.log(rest.timeLimit); // { limit: boolean, date?: string }
|
|
42
46
|
```
|
|
43
47
|
|
|
44
48
|
**Основные свойства**
|
|
@@ -47,12 +51,13 @@ console.log(rest.errors); // ошибки по ключам
|
|
|
47
51
|
- `errors` – словарь ошибок
|
|
48
52
|
- `limit` – текущий лимит команд в чанке (по умолчанию 50)
|
|
49
53
|
- `canContinue` – флаг выполнения
|
|
50
|
-
- `
|
|
54
|
+
- `timeLimit` – глобальный статус лимита (`{ limit, date }`), пригоден для отображения в UI
|
|
51
55
|
|
|
52
56
|
**Методы**
|
|
53
57
|
|
|
54
|
-
- `batch(commandList, progressCall
|
|
55
|
-
- `batchTotalCount(commandList, progressCall
|
|
58
|
+
- `batch(commandList, progressCall?)` – запрос данных
|
|
59
|
+
- `batchTotalCount(commandList, progressCall?)` – запрос количества данных без подробного текста (более быстрый, чем `batch`)
|
|
60
|
+
- `call({ method, params? })` – одиночный REST-вызов с теми же retry/timeout правилами, что и batch
|
|
56
61
|
- `stop()` – принудительная остановка
|
|
57
62
|
|
|
58
63
|
### BxBoot
|
|
@@ -92,14 +97,12 @@ const deals = await bx.batch({
|
|
|
92
97
|
- `appOption(key, value?)` – чтение/запись пользовательских настроек
|
|
93
98
|
- `call({ method, params, updateList })` – одиночный REST-вызов
|
|
94
99
|
- `batch(commandList, progressCall?, options?)` – пакетные вызовы с обновлениями/логом
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
- `updateList` – массив описаний изменений для логера (`method`, `name`, `list[{ id, fields }]`), отображается в истории операций
|
|
98
|
-
- `limitCommandSerial` – устаревший флаг последовательной отправки; сохранен для обратной совместимости, фактически игнорируется
|
|
100
|
+
- `errorCall(errors)` – вызывается после выполнения всего батча, получает объект с ключами запросов и списком ошибок Bitrix24
|
|
101
|
+
- `updateList` – массив описаний изменений для логера (`method`, `name`, `list[{ id, fields }]`), отображается в истории операций
|
|
99
102
|
- `batchTotalCount(commandList, progressCall?, options?)` – подсчет элементов в пакетном режиме
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
+
- `errorCall(errors)` – вызывается после выполнения всего батча, получает объект с ключами запросов и списком ошибок Bitrix24
|
|
104
|
+
- `updateList` – массив описаний изменений для логера (`method`, `name`, `list[{ id, fields }]`), отображается в истории операций
|
|
105
|
+
- `timeLimit` – глобальный статус лимита выполнения (`{ limit, date }`), можно напрямую читать в компонентах (например, в лоадере)
|
|
103
106
|
- `placementBind(place, userId?)`, `placementUnBind(...)`, `placementCheck()` – работа с встройками (кроме `PAGE_BACKGROUND_WORKER`, их ведёт `BackgroundWorker`)
|
|
104
107
|
- `getBotList()`, `regBot()`, `unRegBot()` – управление чат-ботом
|
|
105
108
|
|