@azure/core-lro package
Интерфейсы
| CreateHttpPollerOptions |
Параметры |
| OperationConfig |
Конфигурации для опроса операции и проверки того, завершена ли операция. |
| OperationResponse |
Тип ответа LRO. |
| OperationState |
Хотя опросник работает в качестве локального механизма управления для запуска и ожидания длительной операции, OperationState документирует состояние удаленной длительной операции. Он обновляется после каждого опроса. |
| PollerLike |
Опрос для операции. |
| RawRequest |
Простой тип необработанного запроса. |
| RawResponse |
Простой тип необработанного ответа. |
| RunningOperation |
Описание длительной операции. |
Псевдонимы типа
| CancelOnProgress |
CancelOnProgress используется в качестве возвращаемого значения метода Poller onProgress. При вызове пользователя onProgress необходимо передать функцию, которая будет вызываться как обратный вызов с новыми данными, полученными при каждом обновлении операции опроса. onProgress возвращает функцию, которая предотвратит дальнейшее обновление для получения исходного обратного вызова. |
| OperationStatus |
Набор возможных состояний операции может находиться в любое время. |
| ResourceLocationConfig |
Потенциальное расположение результата LRO, если указано расширением LRO в swagger. |
| RestorableOperationState |
Тип восстанавливаемой длительной операции. |
Функции
| create |
Создает опрашиватель, который можно использовать для опроса длительной операции. |
| deserialize |
Десериализация состояния |
Сведения о функции
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Создает опрашиватель, который можно использовать для опроса длительной операции.
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>
Параметры
- lro
-
RunningOperation<unknown>
Описание длительной операции
- options
-
CreateHttpPollerOptions<TResult, TState>
параметры настройки опрашителя
Возвращаемое значение
PollerLike<TState, TResult>
инициализированный опрос
deserializeState<TResult, TState>(string)
Десериализация состояния
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>
Параметры
- serializedState
-
string
Возвращаемое значение
RestorableOperationState<TResult, TState>