durable-functions package

Třídy

AggregatedError

Při selhání context.df.Task.all() došlo k konkrétní chybě. Zpráva obsahuje agregaci všech výjimek, které selhaly. Měl by se řídit následujícím formátem:

context.df.Task.all() zjistil následující chybové zprávy:

Název: DurableError Message: Funkce aktivity ActivityA se nezdařila. StackTrace: <Trasování zásobníku>

Název: DurableError Message: Funkce aktivity ActivityB se nezdařila. StackTrace: <Trasování zásobníku>

DummyEntityContext

Kontext entity s fiktivními výchozími hodnotami, které usnadňují napodobování a zakrývání rozhraní API Durable Functions.

DummyOrchestrationContext

Kontext orchestrace s fiktivními výchozími hodnotami, které usnadňují napodobování/stubbování rozhraní API Durable Functions.

DurableClient

Klient pro spouštění, dotazování, ukončování a vyvolávání událostí pro orchestraci a instance entit.

DurableError

Specfická chyba vyvolaná v případě, že plánovaná aktivita nebo suborchestrator selhala. Tuto chybu je možné zkontrolovat prostřednictvím ochrany instanceof a zachytit pouze výjimky vyvolané knihovnou DurableJS.

DurableOrchestrationContext

Poskytuje funkce pro kód aplikace, který implementuje operaci orchestrace.

DurableOrchestrationStatus

Představuje stav trvalé instance orchestrace.

Lze načíst pomocí DurableClient.getStatus()

EntityId

Jedinečný identifikátor entity, který se skládá z třídy entity a klíče entity.

EntityStateResponse

Odpověď vrácená DurableClient.readEntityState().

HttpManagementPayload

Datová struktura obsahující koncové body HTTP správy instancí

ManagedIdentityTokenSource

Implementace zdroje tokenů pro spravované identity Azure.

příklad

Seznam předplatných Azure získáte voláním rozhraní HTTP API Azure Resource Manageru.

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

Třída, která má uchovávat statistiky o tomto provádění historie vyprázdnění. Návratový typ DurableClient.purgeHistory()

RetryOptions

Definuje zásady opakování, které lze předat jako parametry různým operacím.

Rozhraní

ActivityOptions
ActivityTrigger
CallHttpOptions

Objekt Options poskytnutý pro callHttp() metody v kontextech orchestrace

DurableClientInput
DurableClientOptions

Konfiguruje vstupy, výstupy a obslužnou rutinu pro funkci Durable Client.

DurableEntityContext

Poskytuje funkce pro kód aplikace, který implementuje operaci entity.

EntityContext

Kontextový objekt předaný funkcím entity.

EntityOptions
EntityTrigger
GetStatusOptions

Objekt Options předaný metodě getStatus() klienta

HttpDurableClientOptions

Konfiguruje možnosti pro funkci Durable Client aktivovanou protokolem HTTP.

OrchestrationContext

Kontextový objekt předaný funkcím orchestrace

OrchestrationFilter

Objekt Options předaný rozhraním DURABLEClient API k filtrování orchestrací, na kterých se mají provádět akce

OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Úloha Durable Functions.

RegisteredOrchestrationTask

Úloha Durable Functions.

StartNewOptions

Objekt Options poskytnutý jako volitelný druhý argument pro metodu client.startNew()

Task

Úloha Durable Functions.

TaskHubOptions

Objekt Options předaný rozhraním DURABLEClient API k určení vlastností centra úloh

TimerDurableClientOptions

Konfiguruje možnosti pro funkci Durable Client aktivovanou časovačem.

TimerTask

Vráceno z DurableClient.createTimer(Date), pokud volání není yield-ed. Představuje čekající časovač. Další informace najdete v dokumentaci k úloze.

Všechny čekající časovače musí být dokončeny nebo zrušeny, aby se orchestrace dokončila.

příklad

Zrušení časovače

// 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();
}

příklad

Vytvoření časového limitu

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

Objekt Options předaný metodě durableClient.waitForCompletionOrCreateCheckStatusResponse() k určení časových limitů, jak dlouho čekat na výstup z odolné funkce a jak často se má zkontrolovat výstup.

Aliasy typu

ActivityHandler
DurableClientHandler

Typ funkce obslužné rutiny, která je aktivována některými triggery a přijímá DurableClient instanci jako vstup.

EntityHandler
HttpDurableClientHandler
OrchestrationHandler

Typ generátoru, který lze zaregistrovat jako orchestraci

RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

Výčty

OrchestrationRuntimeStatus

Stav instance orchestrace

Funkce

getClient(InvocationContext)

Vrátí instanci OrchestrationClient.

Podrobnosti funkce

getClient(InvocationContext)

Vrátí instanci OrchestrationClient.

function getClient(context: InvocationContext): DurableClient

Parametry

context
InvocationContext

Kontextový objekt funkce Azure, jehož tělo volá tuto metodu.

Návraty