durable-functions package

Классы

AggregatedError

Определенная ошибка, возникаемая при сбое context.df.Task.all(). Его сообщение содержит агрегирование всех исключений, которые завершилось сбоем. Он должен соответствовать следующему формату:

context.df.Task.all() обнаружил следующие сообщения об ошибках:

Имя: Сообщение УстойчивыйError: сбой функции действия "ActivityA". StackTrace: <трассировка стека>

Имя: сообщение DurableError: сбой функции действия "ActivityB". StackTrace: <трассировка стека>

DummyEntityContext

Контекст сущности со фиктивными значениями по умолчанию для упрощения макетирования или ступеней API устойчивых функций.

DummyOrchestrationContext

Контекст оркестрации со фиктивными значениями по умолчанию для упрощения макетирования и создания ступеней API устойчивых функций.

DurableClient

Клиент для запуска, запроса, прекращения и создания событий для оркестрации и экземпляров сущностей.

DurableError

Ошибка спецификации, возникающая при сбое запланированного действия или подстраховки. Эта ошибка может быть проверена с помощью instanceof охранников, чтобы перехватывать только исключения, создаваемые библиотекой DurableJS.

DurableOrchestrationContext

Предоставляет функциональные возможности для кода приложения, реализующего операцию оркестрации.

DurableOrchestrationStatus

Представляет состояние устойчивого экземпляра оркестрации.

Можно получить с помощью DurableClient.getStatus()

EntityId

Уникальный идентификатор сущности, состоящий из класса сущности и ключа сущности.

EntityStateResponse

Ответ, возвращаемый УстойчивыйClient.readEntityState().

HttpManagementPayload

Структура данных, содержащая конечные точки HTTP управления экземплярами.

ManagedIdentityTokenSource

Реализация источника токенов для управляемых удостоверений Azure.

пример

Получите список подписок Azure, вызвав HTTP API Azure Resource Manager.

const df = require("durable-functions");

df.app.orchestration(function* (context) {
  return yield context.df.callHttp({
      method: "GET",
      url: "https://management.azure.com/subscriptions?api-version=2019-06-01",
      tokenSource: df.ManagedIdentityTokenSource("https://management.core.windows.net"),
  });
});
PurgeHistoryResult

Класс для хранения статистики об этом выполнении журнала очистки. Тип возвращаемого значения DurableClient.purgeHistory()

RetryOptions

Определяет политики повторных попыток, которые можно передать в качестве параметров в различные операции.

Интерфейсы

ActivityOptions
ActivityTrigger
CallHttpOptions

Объект Options, предоставленный для callHttp() методов в контекстах оркестрации

DurableClientInput
DurableClientOptions

Настраивает входные данные, выходные данные и обработчик для функции устойчивых клиентов.

DurableEntityContext

Предоставляет функциональные возможности для кода приложения, реализующего операцию сущности.

EntityContext

Объект контекста, переданный в функции сущности.

EntityOptions
EntityTrigger
GetStatusOptions

Объект Options, переданный методу getStatus() клиента

HttpDurableClientOptions

Настраивает параметры для функции устойчивых клиентов с поддержкой HTTP.

OrchestrationContext

Объект контекста, переданный в функции оркестрации.

OrchestrationFilter

Объект Options, переданный в API-интерфейсы DurableClient, чтобы фильтровать оркестрации, для которых выполняются действия

OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Задача устойчивых функций.

RegisteredOrchestrationTask

Задача устойчивых функций.

StartNewOptions

Объект Options, предоставленный в качестве дополнительного второго аргумента для метода client.startNew()

Task

Задача устойчивых функций.

TaskHubOptions

Объект Options, переданный в API УстойчивыйClient, чтобы указать свойства концентратора задач

TimerDurableClientOptions

Настраивает параметры для функции устойчивого клиента с активацией таймера.

TimerTask

Возвращается из DurableClient.createTimer(Date), если вызов не yield-ed. Представляет ожидающий таймер. Дополнительные сведения см. в документации по задачам.

Все ожидающие таймеры должны быть завершены или отменены для завершения оркестрации.

пример

Отмена таймера

// calculate expiration date
const timeoutTask = context.df.createTimer(expirationDate);

// do some work

if (!timeoutTask.isCompleted) {
    // An orchestration won't get marked as completed until all its scheduled
    // tasks have returned, or been cancelled. Therefore, it is important
    // to cancel timers when they're no longer needed
    timeoutTask.cancel();
}

пример

Создание времени ожидания

const now = Date.now();
const expiration = new Date(now.valueOf()).setMinutes(now.getMinutes() + 30);

const timeoutTask = context.df.createTimer(expirationDate);
const otherTask = context.df.callActivity("DoWork");

const winner = yield context.df.Task.any([timeoutTask, otherTask]);

if (winner === otherTask) {
    // do some more work
}

if (!timeoutTask.isCompleted) {
    // An orchestration won't get marked as completed until all its scheduled
    // tasks have returned, or been cancelled. Therefore, it is important
    // to cancel timers when they're no longer needed
    timeoutTask.cancel();
}
WaitForCompletionOptions

Объект Options, переданный методу durableClient.waitForCompletionOrCreateCheckStatusResponse(), чтобы указать время ожидания выходных данных из устойчивой функции и частоту проверки выходных данных.

Псевдонимы типа

ActivityHandler
DurableClientHandler

Тип функции обработчика, которая активируется некоторыми триггерами и получает экземпляр УстойчивыйClient в качестве входных данных.

EntityHandler
HttpDurableClientHandler
OrchestrationHandler

Тип генератора, который можно зарегистрировать в качестве оркестрации

RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

Перечисления

OrchestrationRuntimeStatus

Состояние экземпляра оркестрации.

Функции

getClient(InvocationContext)

Возвращает экземпляр OrchestrationClient.

Сведения о функции

getClient(InvocationContext)

Возвращает экземпляр OrchestrationClient.

function getClient(context: InvocationContext): DurableClient

Параметры

context
InvocationContext

Объект контекста функции Azure, тело которого вызывает этот метод.

Возвращаемое значение