Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wmakeev committed Feb 13, 2025
1 parent 95b0853 commit 696134c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
- [Виды событий](#виды-событий)
- [`request` - отправка запроса](#request---отправка-запроса)
- [`response` - получение ответа](#response---получение-ответа)
- [`fetch-error` - ошибка при попытке выполнить запрос](#fetch-error---ошибка-при-попытке-выполнить-запрос)
- [Пример: Разделение лимита между разными процессами](#пример-разделение-лимита-между-разными-процессами)

## Быстрый старт
Expand Down Expand Up @@ -389,6 +390,15 @@ const fetchPlanner = new FetchPlanner(fetch, {
| `responseType` | `string` | Тип запроса. `OK` - успешный запрос; `RATE_LIMIT_OVERFLOW` - ошибка 429 TooManyRequests; `PARALLEL_LIMIT_OVERFLOW` - ошибка превышения лимита параллельных запросов |
| `endTime` | `number` | Время получения ответа |

#### `fetch-error` - ошибка при попытке выполнить запрос

Содержит все поля из события `request` и дополнительно:

| Наименование | Тип | Описание |
| ------------ | -------- | ---------------------- |
| `error` | `Error` | Объект ошибки |
| `errorTime` | `number` | Время получения ошибки |

## Пример: Разделение лимита между разными процессами

Алгоритм планировщика позволяет динамически управлять частотой запросов в зависимости от значения текущих лимитов API МойСклад. Поэтому даже при одновременной работе нескольких приложений в разных процессах нагрузка не будет превышать в среднем 15 запросов в секунду (в соответствии с лимитами API МойСклад - не более 45 запросов в течение 3-х секунд).
Expand Down

0 comments on commit 696134c

Please sign in to comment.