Skip to main content

IAct

@rotorsoft/act-root

@rotorsoft/act-root / act/src / IAct

Interface: IAct<TEvents, TActions, TActor>

Defined in: libs/act/src/types/action.ts:626

Type Parameters​

TEvents​

TEvents extends Schemas = Schemas

TActions​

TActions extends Schemas = Schemas

TActor​

TActor extends Actor = Actor

Methods​

do()​

do<TKey>(action, target, payload, reactingTo?, skipValidation?): Promise<Snapshot<any, any>[]>

Defined in: libs/act/src/types/action.ts:631

Type Parameters​

TKey​

TKey extends string

Parameters​

action​

TKey

target​

Target<TActor>

payload​

Readonly<TActions[TKey]>

reactingTo?​

Committed<Schemas, string>

skipValidation?​

boolean

Returns​

Promise<Snapshot<any, any>[]>

load()​

load(state, stream, callback?, asOf?): Promise<Snapshot<any, any>>

Defined in: libs/act/src/types/action.ts:639

Parameters​

state​

string | State<any, any, any, string>

stream​

string

callback?​

(snapshot) => void

asOf?​

AsOf

Returns​

Promise<Snapshot<any, any>>

query()​

query(query, callback?): Promise<{ count: number; first?: Committed<TEvents, keyof TEvents>; last?: Committed<TEvents, keyof TEvents>; }>

Defined in: libs/act/src/types/action.ts:646

Parameters​

query​

Query

callback?​

(event) => void

Returns​

Promise<{ count: number; first?: Committed<TEvents, keyof TEvents>; last?: Committed<TEvents, keyof TEvents>; }>

query_array()​

query_array(query): Promise<Committed<TEvents, keyof TEvents>[]>

Defined in: libs/act/src/types/action.ts:655

Parameters​

query​

Query

Returns​

Promise<Committed<TEvents, keyof TEvents>[]>