durable-functions package

Classes

AggregatedError

Erreur spécifique levée lorsque context.df.Task.all() échoue. Son message contient une agrégation de toutes les exceptions qui ont échoué. Il doit suivre le format ci-dessous :

context.df.Task.all() a rencontré les messages d’erreur ci-dessous :

Nom : DurableError Message : Échec de la fonction d’activité « ActivityA ». StackTrace : <stacktrace>

Nom : DurableError Message : Échec de la fonction d’activité « ActivityB ». StackTrace : <stacktrace>

DummyEntityContext

Contexte d’entité avec des valeurs par défaut factices pour faciliter la simulation/stubbing de l’API Durable Functions.

DummyOrchestrationContext

Contexte d’orchestration avec des valeurs par défaut factices pour faciliter la simulation/stubbing de l’API Durable Functions.

DurableClient

Client pour le démarrage, l’interrogation, la fin et le déclenchement d’événements vers des instances d’orchestration et d’entité.

DurableError

Erreur de spécification levée lorsqu’une activité planifiée ou un sous-orchestrator a échoué. Cette erreur peut être vérifiée via instanceof gardes pour intercepter uniquement les exceptions levées par la bibliothèque DurableJS.

DurableOrchestrationContext

Fournit des fonctionnalités pour le code d’application implémentant une opération d’orchestration.

DurableOrchestrationStatus

Représente l’état d’une instance d’orchestration durable.

Peut être récupéré à l’aide de DurableClient.getStatus()

EntityId

Identificateur unique d’une entité, composé de la classe d’entité et de la clé d’entité.

EntityStateResponse

Réponse retournée par DurableClient.readEntityState().

HttpManagementPayload

Structure de données contenant des points de terminaison HTTP de gestion d’instance.

ManagedIdentityTokenSource

Implémentation de la source de jeton pour identités managées Azure.

exemple de

Obtenez la liste des abonnements Azure en appelant l’API HTTP 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

Classe pour contenir des statistiques sur cette exécution de l’historique de vidage. Type de retour de DurableClient.purgeHistory()

RetryOptions

Définit des stratégies de nouvelle tentative qui peuvent être passées en tant que paramètres à différentes opérations.

Interfaces

ActivityOptions
ActivityTrigger
CallHttpOptions

Objet Options fourni pour callHttp() méthodes sur les contextes d’orchestration

DurableClientInput
DurableClientOptions

Configure les entrées, sorties et gestionnaires d’une fonction Durable Client.

DurableEntityContext

Fournit des fonctionnalités pour le code d’application implémentant une opération d’entité.

EntityContext

Objet de contexte passé à entity Functions.

EntityOptions
EntityTrigger
GetStatusOptions

Objet Options transmis à la méthode de getStatus() client

HttpDurableClientOptions

Configure les options d’une fonction Durable Client déclenchée par HTTP.

OrchestrationContext

Objet de contexte passé à Functions d’orchestration.

OrchestrationFilter

Objet Options transmis aux API DurableClient pour filtrer les orchestrations sur lesquelles effectuer des actions

OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Tâche Durable Functions.

RegisteredOrchestrationTask

Tâche Durable Functions.

StartNewOptions

Objet Options fourni en tant que deuxième argument facultatif pour la méthode client.startNew()

Task

Tâche Durable Functions.

TaskHubOptions

Objet Options transmis aux API DurableClient pour spécifier les propriétés du hub de tâches

TimerDurableClientOptions

Configure les options d’une fonction Durable Client déclenchée par un minuteur.

TimerTask

Retourné à partir de durableClient.createTimer(Date) si l’appel n’est pas yield-ed. Représente un minuteur en attente. Pour plus d’informations, consultez la documentation sur tâche.

Tous les minuteurs en attente doivent être terminés ou annulés pour qu’une orchestration se termine.

exemple de

Annuler un minuteur

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

exemple de

Créer un délai d’expiration

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

Objet Options transmis à la méthode durableClient.waitForCompletionOrCreateCheckStatusResponse() pour spécifier les délais d’attente pour la durée d’attente de la sortie de la fonction durable et la fréquence de vérification de la sortie.

Alias de type

ActivityHandler
DurableClientHandler

Type d’une fonction de gestionnaire déclenchée par un déclencheur et reçoit une instance DurableClient en tant qu’entrée.

EntityHandler
HttpDurableClientHandler
OrchestrationHandler

Type d’un générateur pouvant être inscrit en tant qu’orchestration

RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

Énumérations

OrchestrationRuntimeStatus

État d’une instance d’orchestration.

Functions

getClient(InvocationContext)

Retourne une instance OrchestrationClient.

Informations relatives à la fonction

getClient(InvocationContext)

Retourne une instance OrchestrationClient.

function getClient(context: InvocationContext): DurableClient

Paramètres

context
InvocationContext

Objet de contexte de la fonction Azure dont le corps appelle cette méthode.

Retours