durable-functions package

類別

AggregatedError

context.df.Task.all() 失敗時擲回的特定錯誤。 其訊息包含所有失敗例外狀況的匯總。 它應該遵循下列格式:

context.df.Task.all() 遇到下列錯誤訊息:

名稱:DurableError 訊息:活動函式 「ActivityA」 失敗。 StackTrace: <堆疊跟蹤>

名稱:DurableError 訊息:活動函式 「ActivityB」 失敗。 StackTrace: <堆疊跟蹤>

DummyEntityContext

具有虛擬預設值的實體內容,可協助模擬/Stubbing Durable Functions API。

DummyOrchestrationContext

具有虛擬預設值的協調流程內容,可協助模擬/Stubbing Durable Functions API。

DurableClient

用戶端,用於啟動、查詢、終止和引發事件至協調流程和實體實例。

DurableError

當排程的活動或子管理員失敗時,所擲回的規格錯誤。 您可以透過 instanceof 防護檢查此錯誤,只攔截 DurableJS 連結庫擲回的例外狀況。

DurableOrchestrationContext

提供實作協調流程作業的應用程式程式代碼功能。

DurableOrchestrationStatus

表示長期協調流程實例的狀態。

可以使用 DurableClient.getStatus() 來擷取

EntityId

實體的唯一標識碼,包含實體類別和實體索引鍵。

EntityStateResponse

DurableClient.readEntityState() 所傳回的回應。

HttpManagementPayload

包含實例管理 HTTP 端點的數據結構。

ManagedIdentityTokenSource

Azure 受控識別的權杖來源實作

範例

呼叫 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() 方法的選項物件

DurableClientInput
DurableClientOptions

設定 Durable Client 函式的輸入、輸出和處理程式。

DurableEntityContext

提供實作實體作業的應用程式程式代碼功能。

EntityContext

傳遞至實體 Functions 的內容物件。

EntityOptions
EntityTrigger
GetStatusOptions

傳遞至用戶端 getStatus() 方法的選項物件

HttpDurableClientOptions

設定 HTTP 觸發的 Durable Client 函式的選項。

OrchestrationContext

傳遞至協調流程函式的內容物件。

OrchestrationFilter

傳遞至 DurableClient API 的選項物件,以篩選要對其執行動作的協調流程

OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Durable Functions 工作。

RegisteredOrchestrationTask

Durable Functions 工作。

StartNewOptions

options 物件提供為 client.startNew() 方法的選擇性第二個自變數

Task

Durable Functions 工作。

TaskHubOptions

傳遞至 DurableClient API 以指定工作中樞屬性的選項物件

TimerDurableClientOptions

設定定時器觸發的 Durable Client 函式的選項。

TimerTask

DurableClient傳回。如果呼叫不是 createTimer(Date)-ed,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() 方法的選項物件,可指定等候長期函式輸出的時間長度,以及檢查輸出的頻率。

類型別名

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 函式的內容物件,其主體會呼叫此方法。

傳回