DurableEntityContext interface

Pacote:

durable-functions

Fornece funcionalidade para código de aplicativo implementando uma operação de entidade.

Propriedades

entityId	Obtém a id da entidade em execução no momento.
entityKey	Obtém a chave da entidade em execução no momento.
entityName	Obtém o nome da entidade em execução no momento.
isNewlyConstructed	Se esta entidade é recém-construída, ou seja, não existia antes de esta operação ser chamada.
operationName	Obtém o nome da operação que foi chamada. Uma invocação de operação em uma entidade inclui um nome de operação, que indica qual operação executar e, opcionalmente, uma entrada de operação.

Métodos

destructOnExit()	Exclui essa entidade após a conclusão dessa operação.
getInput<TInput>()	Obtém a entrada para esta operação. Uma invocação de operação em uma entidade inclui um nome de operação, que indica qual operação executar e, opcionalmente, uma entrada de operação.
getState(() => TState)	Obtém o estado atual desta entidade, para leitura e/ou escrita.
return<TResult>(TResult)	Retorna o resultado dado para o chamador desta operação.
setState(TState)	Define o estado atual desta entidade.
signalEntity(EntityId, string, unknown)	Sinaliza uma entidade para executar uma operação, sem esperar por uma resposta. Qualquer resultado ou exceção é ignorado (disparar e esquecer).

Detalhes de Propriedade

entityId

Obtém a id da entidade em execução no momento.

entityId: EntityId

Valor de Propriedade

EntityId

entityKey

Obtém a chave da entidade em execução no momento.

entityKey: string

Valor de Propriedade

string

entityName

Obtém o nome da entidade em execução no momento.

entityName: string

Valor de Propriedade

string

isNewlyConstructed

Se esta entidade é recém-construída, ou seja, não existia antes de esta operação ser chamada.

isNewlyConstructed: boolean

Valor de Propriedade

boolean

operationName

Obtém o nome da operação que foi chamada.

Uma invocação de operação em uma entidade inclui um nome de operação, que indica qual operação executar e, opcionalmente, uma entrada de operação.

operationName: undefined | string

Valor de Propriedade

undefined | string

Detalhes de Método

destructOnExit()

Exclui essa entidade após a conclusão dessa operação.

function destructOnExit()

getInput<TInput>()

Obtém a entrada para esta operação.

Uma invocação de operação em uma entidade inclui um nome de operação, que indica qual operação executar e, opcionalmente, uma entrada de operação.

function getInput<TInput>(): undefined | TInput

Devoluções

undefined | TInput

A entrada da operação, ou indefinida se nenhuma.

getState(() => TState)

Obtém o estado atual desta entidade, para leitura e/ou escrita.

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

Parâmetros

initializer

() => TState

Fornece um valor inicial para usar para o estado, em vez do padrão do TState.

Devoluções

undefined | TState

O estado atual desta entidade, ou indefinido se nenhum tiver sido definido ainda.

return<TResult>(TResult)

Retorna o resultado dado para o chamador desta operação.

function return<TResult>(result: TResult)

Parâmetros

result

TResult

O resultado a devolver.

setState(TState)

Define o estado atual desta entidade.

function setState(state: TState)

Parâmetros

state

TState

O estado da entidade.

signalEntity(EntityId, string, unknown)

Sinaliza uma entidade para executar uma operação, sem esperar por uma resposta. Qualquer resultado ou exceção é ignorado (disparar e esquecer).

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

Parâmetros

entity

EntityId

A entidade de destino.

operationName

string

O nome da operação.

operationInput

unknown

A entrada da operação.