DurableEntityContext interface

Paquete:: durable-functions

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

Propiedades

entityId	Obtiene el identificador de la entidad que se está ejecutando actualmente.
entityKey	Obtiene la clave de la entidad que se está ejecutando actualmente.
entityName	Obtiene el nombre de la entidad que se está ejecutando actualmente.
isNewlyConstructed	Si esta entidad está recién construida, es decir, no existía antes de llamar a esta operación.
operationName	Obtiene el nombre de la operación a la que se llamó. Una invocación de operación en una entidad incluye un nombre de operación, que indica qué operación se va a realizar y, opcionalmente, una entrada de operación.

Métodos

destructOnExit()	Elimina esta entidad una vez completada esta operación.
getInput<TInput>()	Obtiene la entrada de esta operación. Una invocación de operación en una entidad incluye un nombre de operación, que indica qué operación se va a realizar y, opcionalmente, una entrada de operación.
getState(() => TState)	Obtiene el estado actual de esta entidad para leer o escribir.
return<TResult>(TResult)	Devuelve el resultado especificado al autor de la llamada de esta operación.
setState(TState)	Establece el estado actual de esta entidad.
signalEntity(EntityId, string, unknown)	Indica a una entidad que realice una operación, sin esperar una respuesta. Cualquier resultado o excepción se omite (desencadena y olvida).

Detalles de las propiedades

entityId

Obtiene el identificador de la entidad que se está ejecutando actualmente.

entityId: EntityId

Valor de propiedad

EntityId

entityKey

Obtiene la clave de la entidad que se está ejecutando actualmente.

entityKey: string

Valor de propiedad

string

entityName

Obtiene el nombre de la entidad que se está ejecutando actualmente.

entityName: string

Valor de propiedad

string

isNewlyConstructed

Si esta entidad está recién construida, es decir, no existía antes de llamar a esta operación.

isNewlyConstructed: boolean

Valor de propiedad

boolean

operationName

Obtiene el nombre de la operación a la que se llamó.

Una invocación de operación en una entidad incluye un nombre de operación, que indica qué operación se va a realizar y, opcionalmente, una entrada de operación.

operationName: undefined | string

Valor de propiedad

undefined | string

Detalles del método

destructOnExit()

Elimina esta entidad una vez completada esta operación.

function destructOnExit()

getInput<TInput>()

Obtiene la entrada de esta operación.

Una invocación de operación en una entidad incluye un nombre de operación, que indica qué operación se va a realizar y, opcionalmente, una entrada de operación.

function getInput<TInput>(): undefined | TInput

Devoluciones

undefined | TInput

Entrada de la operación o no definida si no existe.

getState(() => TState)

Obtiene el estado actual de esta entidad para leer o escribir.

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

Parámetros

initializer: () => TState

Proporciona un valor inicial que se usará para el estado, en lugar del valor predeterminado de TState.

Devoluciones

undefined | TState

El estado actual de esta entidad o undefined si aún no se ha establecido ninguno.

return<TResult>(TResult)

Devuelve el resultado especificado al autor de la llamada de esta operación.

function return<TResult>(result: TResult)

Parámetros

result: TResult

Resultado que se va a devolver.

setState(TState)

Establece el estado actual de esta entidad.

function setState(state: TState)

Parámetros

state: TState

Estado de la entidad.

signalEntity(EntityId, string, unknown)

Indica a una entidad que realice una operación, sin esperar una respuesta. Cualquier resultado o excepción se omite (desencadena y olvida).

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

Parámetros

entity: EntityId

Entidad de destino.

operationName: string

Nombre de la operación.

operationInput: unknown

Entrada de la operación.