Interface InvocationReference`Experimental`

A reference to a target invocation, used to send signals.

interface InvocationReference {
    attach<T>(serde?: Serde<T>): RestatePromise<T>;
    cancel(): void;
    signal<T>(name: string, serde?: Serde<T>): SignalReference<T>;
}

Index

Methods

attach cancel signal

Methods

attach

attach<T>(serde?: Serde<T>): RestatePromise<T>
Experimental
Attach to the target invocation and wait for its result.
Type Parameters
- T
Parameters
- Optionalserde: Serde<T>
  optional custom serializer/deserializer for the result.
Returns RestatePromise<T>
a RestatePromise that resolves with the invocation result.
- Defined in packages/libs/restate-sdk/src/internal.ts:188

cancel

cancel(): void
Experimental
Cancel the target invocation.

Returns void
- Defined in packages/libs/restate-sdk/src/internal.ts:180

signal

signal<T>(name: string, serde?: Serde<T>): SignalReference<T>
Experimental
Get a handle to a named signal on the target invocation.
Type Parameters
- T
Parameters
- name: string
  the name of the signal.
- Optionalserde: Serde<T>
  optional custom serializer/deserializer for the payload.
Returns SignalReference<T>
a SignalReference to resolve or reject the signal.
- Defined in packages/libs/restate-sdk/src/internal.ts:175