DurableEntityContext interface

Paket:: durable-functions

Menyediakan fungsionalitas untuk kode aplikasi yang menerapkan operasi entitas.

Properti

entityId	Mendapatkan id entitas yang sedang dijalankan.
entityKey	Mendapatkan kunci entitas yang sedang dijalankan.
entityName	Mendapatkan nama entitas yang sedang dijalankan.
isNewlyConstructed	Apakah entitas ini baru dibangun, yaitu tidak ada sebelum operasi ini dipanggil.
operationName	Mendapatkan nama operasi yang dipanggil. Pemanggilan operasi pada entitas mencakup nama operasi, yang menyatakan operasi apa yang harus dilakukan, dan secara opsional input operasi.

Metode

destructOnExit()	Menghapus entitas ini setelah operasi ini selesai.
getInput<TInput>()	Mendapatkan input untuk operasi ini. Pemanggilan operasi pada entitas mencakup nama operasi, yang menyatakan operasi apa yang harus dilakukan, dan secara opsional input operasi.
getState(() => TState)	Mendapatkan status entitas ini saat ini, untuk membaca dan/atau menulis.
return<TResult>(TResult)	Mengembalikan hasil yang diberikan kepada pemanggil operasi ini.
setState(TState)	Mengatur status entitas ini saat ini.
signalEntity(EntityId, string, unknown)	Memberi sinyal entitas untuk melakukan operasi, tanpa menunggu respons. Setiap hasil atau pengecualian diabaikan (aktifkan dan lupakan).

Detail Properti

entityId

Mendapatkan id entitas yang sedang dijalankan.

entityId: EntityId

Nilai Properti

EntityId

entityKey

Mendapatkan kunci entitas yang sedang dijalankan.

entityKey: string

Nilai Properti

string

entityName

Mendapatkan nama entitas yang sedang dijalankan.

entityName: string

Nilai Properti

string

isNewlyConstructed

Apakah entitas ini baru dibangun, yaitu tidak ada sebelum operasi ini dipanggil.

isNewlyConstructed: boolean

Nilai Properti

boolean

operationName

Mendapatkan nama operasi yang dipanggil.

Pemanggilan operasi pada entitas mencakup nama operasi, yang menyatakan operasi apa yang harus dilakukan, dan secara opsional input operasi.

operationName: undefined | string

Nilai Properti

undefined | string

Detail Metode

destructOnExit()

Menghapus entitas ini setelah operasi ini selesai.

function destructOnExit()

getInput<TInput>()

Mendapatkan input untuk operasi ini.

Pemanggilan operasi pada entitas mencakup nama operasi, yang menyatakan operasi apa yang harus dilakukan, dan secara opsional input operasi.

function getInput<TInput>(): undefined | TInput

Mengembalikan

undefined | TInput

Input operasi, atau tidak ditentukan jika tidak ada.

getState(() => TState)

Mendapatkan status entitas ini saat ini, untuk membaca dan/atau menulis.

function getState(initializer?: () => TState): undefined | TState

Parameter

initializer: () => TState

Menyediakan nilai awal yang akan digunakan untuk status, bukan default TState.

Mengembalikan

undefined | TState

Status entitas ini saat ini, atau tidak terdefinisi jika belum ada yang ditetapkan.

return<TResult>(TResult)

Mengembalikan hasil yang diberikan kepada pemanggil operasi ini.

function return<TResult>(result: TResult)

Parameter

result: TResult

Hasil yang akan dikembalikan.

setState(TState)

Mengatur status entitas ini saat ini.

function setState(state: TState)

Parameter

state: TState

Status entitas.

signalEntity(EntityId, string, unknown)

Memberi sinyal entitas untuk melakukan operasi, tanpa menunggu respons. Setiap hasil atau pengecualian diabaikan (aktifkan dan lupakan).

function signalEntity(entity: EntityId, operationName: string, operationInput?: unknown)

Parameter

entity: EntityId

Entitas target.

operationName: string

Nama operasi.

operationInput: unknown

Input operasi.