durable-functions package

Clases

AggregatedError

Se produce un error específico cuando se produce un error context.df.Task.all(). Su mensaje contiene una agregación de todas las excepciones con errores. Debe seguir el formato siguiente:

context.df.Task.all() encontró los siguientes mensajes de error:

Name: DurableError Message: Error en la función de actividad "ActivityA". StackTrace: <stacktrace>

Name: DurableError Message: Error en la función de actividad "ActivityB". StackTrace: <stacktrace>
DummyEntityContext

Un contexto de entidad con valores predeterminados ficticios para facilitar el simulacro o el código auxiliar de la API de Durable Functions.
DummyOrchestrationContext

Un contexto de orquestación con valores predeterminados ficticios para facilitar el simulacro o el código auxiliar de la API de Durable Functions.
DurableClient

Cliente para iniciar, consultar, finalizar y generar eventos en instancias de orquestación y entidad.
DurableError

Error de especificación que se produce cuando se ha producido un error en una actividad programada o un suborchestrator. Este error se puede comprobar a través de instanceof guardias para detectar solo las excepciones producidas por la biblioteca DurableJS.
DurableOrchestrationContext

Proporciona funcionalidad para el código de aplicación que implementa una operación de orquestación.
DurableOrchestrationStatus

Representa el estado de una instancia de orquestación duradera.

Se puede capturar mediante DurableClient.getStatus()
EntityId

Identificador único de una entidad, que consta de la clase de entidad y la clave de entidad.
EntityStateResponse

La respuesta devuelta por DurableClient.readEntityState().
HttpManagementPayload

Estructura de datos que contiene puntos de conexión HTTP de administración de instancias.
ManagedIdentityTokenSource

Implementación del origen de tokens para identidades administradas de Azure.

de ejemplo de

Obtenga una lista de suscripciones de Azure mediante una llamada a la API HTTP de 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

Clase que contiene estadísticas sobre esta ejecución del historial de purga. Tipo de valor devuelto de DurableClient.purgeHistory()
RetryOptions

Define las directivas de reintento que se pueden pasar como parámetros a varias operaciones.

Interfaces

ActivityOptions
ActivityTrigger
CallHttpOptions

Objeto Options proporcionado para callHttp() métodos en contextos de orquestación
DurableClientInput
DurableClientOptions

Configura las entradas, salidas y controlador para una función de Durable Client.
DurableEntityContext

Proporciona funcionalidad para el código de aplicación que implementa una operación de entidad.
EntityContext

Objeto de contexto pasado a las funciones de entidad.
EntityOptions
EntityTrigger
GetStatusOptions

Objeto Options pasado al método de getStatus() cliente
HttpDurableClientOptions

Configura las opciones de una función Durable Client desencadenada por HTTP.
OrchestrationContext

Objeto de contexto pasado a funciones de orquestación.
OrchestrationFilter

Objeto Options pasado a las API durableClient para filtrar las orquestaciones en las que realizar acciones
OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Una tarea durable Functions.
RegisteredOrchestrationTask

Una tarea durable Functions.
StartNewOptions

Objeto Options proporcionado como segundo argumento opcional para el método client.startNew()
Task

Una tarea durable Functions.
TaskHubOptions

Objeto Options pasado a las API durableClient para especificar las propiedades del centro de tareas
TimerDurableClientOptions

Configura las opciones de una función durable Client desencadenada por el temporizador.
TimerTask

Se devuelve de durableClient.createTimer(Date) si la llamada no es yield-ed. Representa un temporizador pendiente. Consulte la documentación sobre de tareas para obtener más información.

Todos los temporizadores pendientes deben completarse o cancelarse para que se complete una orquestación.

de ejemplo de

Cancelar un temporizador

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

de ejemplo de

Creación de un tiempo de espera

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

Objeto Options pasado al método durableClient.waitForCompletionOrCreateCheckStatusResponse() para especificar los tiempos de espera durante cuánto tiempo se espera la salida de la función durable y la frecuencia con la que comprobar la salida.

Alias de tipos

ActivityHandler
DurableClientHandler

Tipo de una función de controlador desencadenada por algún desencadenador y recibe una instancia de DurableClient como entrada.
EntityHandler
HttpDurableClientHandler
OrchestrationHandler

Tipo de un generador que se puede registrar como orquestación
RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

Enumeraciones

OrchestrationRuntimeStatus

Estado de una instancia de orquestación.

Funciones

getClient(InvocationContext)

Devuelve una instancia de OrchestrationClient.

Detalles de la función

getClient(InvocationContext)

Devuelve una instancia de OrchestrationClient.

function getClient(context: InvocationContext): DurableClient

Parámetros

context
InvocationContext

Objeto de contexto de la función de Azure cuyo cuerpo llama a este método.

Devoluciones

DurableClient