durable-functions package

Klassen

AggregatedError

Ein bestimmter Fehler wird ausgelöst, wenn context.df.Task.all() fehlschlägt. Die Nachricht enthält eine Aggregation aller fehlgeschlagenen Ausnahmen. Es sollte dem folgenden Format folgen:

context.df.Task.all() hat die folgenden Fehlermeldungen festgestellt:

Name: DurableError Message: Fehler bei der Aktivitätsfunktion "ActivityA". StackTrace: <stacktrace>

Name: DurableError Message: Fehler bei der Aktivitätsfunktion "ActivityB". StackTrace: <stacktrace>

DummyEntityContext

Ein Entitätskontext mit Dummy-Standardwerten, um das Modellieren/Stubbing der Api für dauerhafte Funktionen zu vereinfachen.

DummyOrchestrationContext

Ein Orchestrierungskontext mit Dummy-Standardwerten, um das Modellieren/Stubbing der Api für dauerhafte Funktionen zu vereinfachen.

DurableClient

Client zum Starten, Abfragen, Beenden und Auslösen von Ereignissen für Orchestrierung und Entitätsinstanzen.

DurableError

Ein spekulärer Fehler, der ausgelöst wird, wenn eine geplante Aktivität oder ein Suborchestrator fehlgeschlagen ist. Dieser Fehler kann über instanceof Guards überprüft werden, um nur Ausnahmen abzufangen, die von der DurableJS-Bibliothek ausgelöst werden.

DurableOrchestrationContext

Stellt Funktionen für den Anwendungscode bereit, der einen Orchestrierungsvorgang implementiert.

DurableOrchestrationStatus

Stellt den Status einer dauerhaften Orchestrierungsinstanz dar.

Kann mithilfe von DurableClient.getStatus() abgerufen werden

EntityId

Ein eindeutiger Bezeichner für eine Entität, bestehend aus Entitätsklasse und Entitätsschlüssel.

EntityStateResponse

Die von DurableClient.readEntityState() zurückgegebene Antwort.

HttpManagementPayload

Datenstruktur, die HTTP-Endpunkte für die Instanzverwaltung enthält.

ManagedIdentityTokenSource

Token source implementation for Azure Managed Identities.

Beispiel

Rufen Sie eine Liste der Azure-Abonnements ab, indem Sie die HTTP-API des Azure Resource Manager aufrufen.

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

Klasse, die Statistiken zu dieser Ausführung des Bereinigungsverlaufs enthält. Der Rückgabetyp von DurableClient.purgeHistory()

RetryOptions

Definiert Wiederholungsrichtlinien, die als Parameter an verschiedene Vorgänge übergeben werden können.

Schnittstellen

ActivityOptions
ActivityTrigger
CallHttpOptions

Options-Objekt, das callHttp() Methoden für Orchestrierungskontexte bereitgestellt wird

DurableClientInput
DurableClientOptions

Konfiguriert die Eingaben, Ausgaben und Handler für eine funktion des dauerhaften Clients.

DurableEntityContext

Stellt Funktionen für den Anwendungscode bereit, der einen Entitätsvorgang implementiert.

EntityContext

Kontextobjekt, das an Entitätsfunktionen übergeben wird.

EntityOptions
EntityTrigger
GetStatusOptions

Options-Objekt, das an die Client-getStatus()-Methode übergeben wird

HttpDurableClientOptions

Konfiguriert Optionen für eine http-ausgelöste dauerhafte Clientfunktion.

OrchestrationContext

Kontextobjekt, das an Orchestrierungsfunktionen übergeben wird.

OrchestrationFilter

Options-Objekt, das an DurableClient-APIs übergeben wird, um Orchestrierungen zu filtern, nach denen Aktionen ausgeführt werden sollen

OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Eine Aufgabe für dauerhafte Funktionen.

RegisteredOrchestrationTask

Eine Aufgabe für dauerhafte Funktionen.

StartNewOptions

Options-Objekt, das als optionales zweites Argument für die client.startNew()-Methode bereitgestellt wird

Task

Eine Aufgabe für dauerhafte Funktionen.

TaskHubOptions

Options-Objekt, das an DurableClient-APIs übergeben wird, um Aufgabenhubeigenschaften anzugeben

TimerDurableClientOptions

Konfiguriert Optionen für eine zeitgeberauslöste Durable Client-Funktion.

TimerTask

Wird von DurableClientzurückgegeben.createTimer(Date), wenn der Anruf nicht yield-ed ist. Stellt einen ausstehenden Timer dar. Weitere Informationen finden Sie in der Dokumentation zu Aufgaben-.

Alle ausstehenden Zeitgeber müssen abgeschlossen oder abgebrochen werden, damit eine Orchestrierung abgeschlossen werden kann.

Beispiel

Abbrechen eines Timers

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

Beispiel

Erstellen eines Timeouts

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-Objekt, das an die durableClient.waitForCompletionOrCreateCheckStatusResponse()-Methode übergeben wird, um Timeouts anzugeben, wie lange auf die Ausgabe der dauerhaften Funktion gewartet wird und wie oft die Ausgabe überprüft werden soll.

Typaliase

ActivityHandler
DurableClientHandler

Typ einer Handlerfunktion, die von einem Trigger ausgelöst wird, und empfängt eine DurableClient- Instanz als Eingabe.

EntityHandler
HttpDurableClientHandler
OrchestrationHandler

Typ eines Generators, der als Orchestrierung registriert werden kann

RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

Enumerationen

OrchestrationRuntimeStatus

Der Status einer Orchestrierungsinstanz.

Functions

getClient(InvocationContext)

Gibt eine OrchestrationClient-Instanz zurück.

Details zur Funktion

getClient(InvocationContext)

Gibt eine OrchestrationClient-Instanz zurück.

function getClient(context: InvocationContext): DurableClient

Parameter

context
InvocationContext

Das Kontextobjekt der Azure-Funktion, deren Textkörper diese Methode aufruft.

Gibt zurück