DurableEntityContext interface

Пакет:: durable-functions

Предоставляет функциональные возможности для кода приложения, реализующего операцию сущности.

Свойства

entityId	Возвращает идентификатор выполняемой сущности.
entityKey	Возвращает ключ текущей выполняемой сущности.
entityName	Возвращает имя текущей выполняемой сущности.
isNewlyConstructed	Является ли эта сущность недавно созданной, т. е. не существовала до вызова этой операции.
operationName	Возвращает имя вызываемой операции. Вызов операции для сущности включает имя операции, которое указывает, какая операция выполняется, а при необходимости — входные данные операции.

Методы

destructOnExit()	Удаляет эту сущность после завершения этой операции.
getInput<TInput>()	Возвращает входные данные для этой операции. Вызов операции для сущности включает имя операции, которое указывает, какая операция выполняется, а при необходимости — входные данные операции.
getState(() => TState)	Возвращает текущее состояние этой сущности для чтения и записи или записи.
return<TResult>(TResult)	Возвращает заданный результат вызывающей операции.
setState(TState)	Задает текущее состояние этой сущности.
signalEntity(EntityId, string, unknown)	Сигнализирует сущности выполнять операцию, не ожидая ответа. Любой результат или исключение игнорируется (огонь и забудь).

Сведения о свойстве

entityId

Возвращает идентификатор выполняемой сущности.

entityId: EntityId

Значение свойства

EntityId

entityKey

Возвращает ключ текущей выполняемой сущности.

entityKey: string

Значение свойства

string

entityName

Возвращает имя текущей выполняемой сущности.

entityName: string

Значение свойства

string

isNewlyConstructed

Является ли эта сущность недавно созданной, т. е. не существовала до вызова этой операции.

isNewlyConstructed: boolean

Значение свойства

boolean

operationName

Возвращает имя вызываемой операции.

Вызов операции для сущности включает имя операции, которое указывает, какая операция выполняется, а при необходимости — входные данные операции.

operationName: undefined | string

Значение свойства

undefined | string

Сведения о методе

destructOnExit()

Удаляет эту сущность после завершения этой операции.

function destructOnExit()

getInput<TInput>()

Возвращает входные данные для этой операции.

function getInput<TInput>(): undefined | TInput

Возвращаемое значение

undefined | TInput

Входные данные операции или не определено, если нет.

getState(() => TState)

Возвращает текущее состояние этой сущности для чтения и записи или записи.

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

Параметры

initializer: () => TState

Предоставляет начальное значение, используемое для состояния, а не значение по умолчанию TState.

Возвращаемое значение

undefined | TState

Текущее состояние этой сущности или не определено, если он еще не задан.

return<TResult>(TResult)

Возвращает заданный результат вызывающей операции.

function return<TResult>(result: TResult)

Параметры

result: TResult

Результат, возвращаемый.

setState(TState)

Задает текущее состояние этой сущности.

function setState(state: TState)

Параметры

state: TState

Состояние сущности.

signalEntity(EntityId, string, unknown)

Сигнализирует сущности выполнять операцию, не ожидая ответа. Любой результат или исключение игнорируется (огонь и забудь).

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

Параметры

entity: EntityId

Целевая сущность.

operationName: string

Имя операции.

operationInput: unknown

Входные данные операции.