DurableEntityContext interface

패키지:

durable-functions

엔터티 작업을 구현하는 애플리케이션 코드에 대한 기능을 제공합니다.

속성

entityId	현재 실행 중인 엔터티의 ID를 가져옵니다.
entityKey	현재 실행 중인 엔터티의 키를 가져옵니다.
entityName	현재 실행 중인 엔터티의 이름을 가져옵니다.
isNewlyConstructed	이 엔터티가 새로 생성되었는지 여부, 즉 이 작업이 호출되기 전에는 존재하지 않았습니다.
operationName	호출된 작업의 이름을 가져옵니다. 엔터티에 대한 작업 호출에는 수행할 작업을 나타내는 작업 이름과 선택적으로 작업 입력이 포함됩니다.

메서드

destructOnExit()	이 작업이 완료된 후 이 엔터티를 삭제합니다.
getInput<TInput>()	이 작업에 대한 입력을 가져옵니다. 엔터티에 대한 작업 호출에는 수행할 작업을 나타내는 작업 이름과 선택적으로 작업 입력이 포함됩니다.
getState(() => TState)	읽기 및/또는 쓰기에 대한 이 엔터티의 현재 상태를 가져옵니다.
return<TResult>(TResult)	지정된 결과를 이 작업의 호출자에게 반환합니다.
setState(TState)	이 엔터티의 현재 상태를 설정합니다.
signalEntity(EntityId, string, unknown)	응답을 기다리지 않고 엔터티가 작업을 수행하도록 신호를 전송합니다. 모든 결과 또는 예외는 무시됩니다(fire and forget).

속성 세부 정보

entityId

현재 실행 중인 엔터티의 ID를 가져옵니다.

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)

응답을 기다리지 않고 엔터티가 작업을 수행하도록 신호를 전송합니다. 모든 결과 또는 예외는 무시됩니다(fire and forget).

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

매개 변수

entity

EntityId

대상 엔터티입니다.

operationName

string

작업의 이름입니다.

operationInput

unknown

작업 입력입니다.