itd-api / SessionOptions
Interface: SessionOptions
Defined in: session/options.ts:90
Настройки сессии: чем представляться и как её продлевать.
Отделены от RuntimeOptions намеренно: минимальному клиенту с готовым токеном ничего из этого не нужно, и он не должен тянуть за собой ни хранилище, ни разбор JWT, ни вход по паролю.
Extended by
Properties
auth?
optional auth?: AuthInput;Defined in: session/options.ts:92
Авторизация. Без неё доступны только публичные эндпоинты.
autoRefresh?
optional autoRefresh?: boolean;Defined in: session/options.ts:109
Обновлять токен перед истечением и восстанавливать сессию при ответе 401. По умолчанию true.
При false библиотека просто пробросит ItdAuthError, а обновлением вы управляете сами через itd.auth.refresh().
captcha?
optional captcha?: CaptchaSolverInput;Defined in: session/options.ts:99
Откуда брать токен капчи, когда сервер её потребует: при входе по паролю, регистрации, запросе письма для сброса пароля и подтверждении QR-входа.
С этой опцией токен можно не передавать в сами методы — клиент получит его сам.
deviceId?
optional deviceId?: string;Defined in: session/options.ts:123
Значение заголовка X-Device-Id, который уходит с каждым запросом.
Сервер различает по нему записи в списке сессий, поэтому значение должно быть стабильным. Если не задать, библиотека заведёт идентификатор сама и сохранит его в ItdSession, так что при постоянном хранилище он переживёт перезапуск процесса.
reloginOnRefreshFailure?
optional reloginOnRefreshFailure?: boolean;Defined in: session/options.ts:115
Пытаться ли войти заново, если обновление токена не удалось.
Работает, только когда в auth переданы email и пароль. По умолчанию true.
storage?
optional storage?: TokenStorage;Defined in: session/options.ts:101
Где хранить сессию. По умолчанию MemoryTokenStorage.