durable-functions package

クラス

AggregatedError

context.df.Task.all() が失敗したときにスローされる特定のエラー。 そのメッセージには、失敗したすべての例外の集計が含まれています。 次の形式に従う必要があります。

context.df.Task.all() で次のエラー メッセージが発生しました。

名前: DurableError メッセージ: アクティビティ関数 "ActivityA" が失敗しました。 スタックトレース: <スタックトレース>

名前: DurableError メッセージ: アクティビティ関数 "ActivityB" が失敗しました。 スタックトレース: <スタックトレース>
DummyEntityContext

Durable Functions API のモック作成/スタブを容易にするダミーの既定値を持つエンティティ コンテキスト。
DummyOrchestrationContext

Durable Functions API のモック作成/スタブを容易にするダミーの既定値を持つオーケストレーション コンテキスト。
DurableClient

オーケストレーションおよびエンティティ インスタンスに対するイベントの開始、クエリ、終了、および発生のためのクライアント。
DurableError

スケジュールされたアクティビティまたはサブオーキストレーターが失敗したときにスローされる仕様エラー。 このエラーは、durableJS ライブラリによってスローされた例外のみをキャッチするために、instanceof ガードを介して確認できます。
DurableOrchestrationContext

オーケストレーション操作を実装するアプリケーション コードの機能を提供します。
DurableOrchestrationStatus

永続的オーケストレーション インスタンスの状態を表します。

DurableClient.getStatus() を使用してフェッチできます
EntityId

エンティティ クラスとエンティティ キーで構成されるエンティティの一意識別子。
EntityStateResponse

DurableClient.readEntityState() によって返される応答。
HttpManagementPayload

インスタンス管理 HTTP エンドポイントを含むデータ構造。
ManagedIdentityTokenSource

Azure マネージド IDのトークン ソースの実装。

例

Azure Resource Manager HTTP API を呼び出して、Azure サブスクリプションの一覧を取得します。

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

オーケストレーション コンテキストでメソッドを callHttp() するために提供される Options オブジェクト
DurableClientInput
DurableClientOptions

Durable Client 関数の入力、出力、ハンドラーを構成します。
DurableEntityContext

エンティティ操作を実装するアプリケーション コードの機能を提供します。
EntityContext

エンティティ Functions に渡されるコンテキスト オブジェクト。
EntityOptions
EntityTrigger
GetStatusOptions

クライアント getStatus() メソッドに渡される Options オブジェクト
HttpDurableClientOptions

HTTP によってトリガーされる Durable Client 関数のオプションを構成します。
OrchestrationContext

オーケストレーション関数に渡されるコンテキスト オブジェクト。
OrchestrationFilter

アクションを実行するオーケストレーションをフィルター処理するために DurableClient API に渡される Options オブジェクト
OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Durable Functions タスク。
RegisteredOrchestrationTask

Durable Functions タスク。
StartNewOptions

client.startNew() メソッドのオプションの 2 番目の引数として提供される Options オブジェクト
Task

Durable Functions タスク。
TaskHubOptions

タスク ハブのプロパティを指定するために DurableClient API に渡される Options オブジェクト
TimerDurableClientOptions

タイマーによってトリガーされる Durable Client 関数のオプションを構成します。
TimerTask

DurableClient から返されます。呼び出しが -ed createTimer(Date)されていない場合にyield します。 保留中のタイマーを表します。 詳細については、タスク に関するドキュメントを参照してください。

オーケストレーションを完了するには、保留中のすべてのタイマーを完了または取り消す必要があります。

例

タイマーを取り消す

// 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

durableClient.waitForCompletionOrCreateCheckStatusResponse() メソッドに渡される Options オブジェクトは、durable 関数からの出力を待機する時間と出力を確認する頻度のタイムアウトを指定します。

型エイリアス

ActivityHandler
DurableClientHandler

何らかのトリガーによってトリガーされ、DurableClient インスタンスを入力として受け取るハンドラー関数の型。
EntityHandler
HttpDurableClientHandler
OrchestrationHandler

オーケストレーションとして登録できるジェネレーターの種類
RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

列挙型

OrchestrationRuntimeStatus

オーケストレーション インスタンスの状態。

関数

getClient(InvocationContext)

OrchestrationClient インスタンスを返します。

関数の詳細

getClient(InvocationContext)

OrchestrationClient インスタンスを返します。

function getClient(context: InvocationContext): DurableClient

パラメーター

context
InvocationContext

本体がこのメソッドを呼び出す Azure 関数のコンテキスト オブジェクト。

戻り値

DurableClient