Class Client

Sends calls to the worker holding a Fusee server's shards.

Index

Methods

batch call close complete debounce fail list objectRef run signalWithStart start updateWithStart connect

Methods

batch

batch<E, O = unknown>(
    wf: string | WorkflowDefinition<any, O>,
    key: string,
    event: E,
    opts?: BatchOptions,
): Promise<RemoteRun<O>>
Adds an event to the batch of workflow type type under key (see Workflow.batch).
Type Parameters
- E
- O = unknown
Parameters
- wf: string | WorkflowDefinition<any, O>
- key: string
- event: E
- opts: BatchOptions = {}
Returns Promise<RemoteRun<O>>

call

call<T = unknown>(method: string, args: object): Promise<T>
Type Parameters
- T = unknown
Parameters
- method: string
- args: object
Returns Promise<T>

close

close(): void

Returns void

complete

complete(token: string, value?: unknown): Promise<void>
Parameters
- token: string
- Optionalvalue: unknown
Returns Promise<void>

debounce

debounce<I, O = unknown>(
    wf: string | WorkflowDefinition<I, O>,
    key: string,
    input: I,
    opts: DebounceOptions,
): Promise<RemoteRun<O>>
Debounces a start of workflow type type under key (see Workflow.debounce).
Type Parameters
- I
- O = unknown
Parameters
- wf: string | WorkflowDefinition<I, O>
- key: string
- input: I
- opts: DebounceOptions
Returns Promise<RemoteRun<O>>

fail

fail(token: string, error: string): Promise<void>
Parameters
- token: string
- error: string
Returns Promise<void>

list

list(
where?: Record<string, unknown>,
limit?: number,
): Promise<Record<string, unknown>[]>
Parameters
- where: Record<string, unknown> = {}
- limit: number = 100
Returns Promise<Record<string, unknown>[]>

objectRef

objectRef(type: string, key: string): RemoteObjectRef
Key key of object type type, called through the server.
Parameters
- type: string
- key: string
Returns RemoteObjectRef

run

run<O = unknown>(id: string): RemoteRun<O>
Type Parameters
- O = unknown
Parameters
- id: string
Returns RemoteRun<O>

signalWithStart

signalWithStart<I, O, T>(
    wf: string | WorkflowDefinition<I, O>,
    id: string,
    input: I,
    sig: string | SignalDefinition<T>,
    value: T,
    opts?: StartOptions & { version?: number },
): Promise<RemoteRun<O>>
As Engine.signalWithStart.
Type Parameters
- I
- O
- T
Parameters
- wf: string | WorkflowDefinition<I, O>
- id: string
- input: I
- sig: string | SignalDefinition<T>
- value: T
- opts: StartOptions & { version?: number } = {}
Returns Promise<RemoteRun<O>>

start

start<I, O = unknown>(
    wf: string | WorkflowDefinition<I, O>,
    id: string,
    input: I,
    opts?: StartOptions & {
        at?: number | Date;
        delay?: Duration;
        version?: number;
    },
): Promise<RemoteRun<O>>
As Engine.start: a definition or a type name; delay/at start it later.
Type Parameters
- I
- O = unknown
Parameters
- wf: string | WorkflowDefinition<I, O>
- id: string
- input: I
- opts: StartOptions & { at?: number | Date; delay?: Duration; version?: number } = {}
Returns Promise<RemoteRun<O>>

updateWithStart

updateWithStart<I, O, A, R>(
    wf: string | WorkflowDefinition<I, O>,
    id: string,
    input: I,
    upd: string | UpdateDefinition<A, R>,
    arg: A,
    opts?: StartOptions & UpdateOptions & { version?: number },
): Promise<{ result: R; run: RemoteRun<O> }>
As Engine.updateWithStart: the run and the update's result.
Type Parameters
- I
- O
- A
- R
Parameters
- wf: string | WorkflowDefinition<I, O>
- id: string
- input: I
- upd: string | UpdateDefinition<A, R>
- arg: A
- opts: StartOptions & UpdateOptions & { version?: number } = {}
Returns Promise<{ result: R; run: RemoteRun<O> }>

`Static`connect

connect(address: string): Promise<Client>
Parameters
- address: string
Returns Promise<Client>

Class Client

Index

Methods

Methods

batch

Type Parameters

Parameters

Returns Promise<RemoteRun<O>>

call

Type Parameters

Parameters

Returns Promise<T>

close

Returns void

complete

Parameters

Returns Promise<void>

debounce

Type Parameters

Parameters

Returns Promise<RemoteRun<O>>

fail

Parameters

Returns Promise<void>

list

Parameters

Returns Promise<Record<string, unknown>[]>

objectRef

Parameters

Returns RemoteObjectRef

run

Type Parameters

Parameters

Returns RemoteRun<O>

signalWithStart

Type Parameters

Parameters

Returns Promise<RemoteRun<O>>

start

Type Parameters

Parameters

Returns Promise<RemoteRun<O>>

updateWithStart

Type Parameters

Parameters

Returns Promise<{ result: R; run: RemoteRun<O> }>

Staticconnect

Parameters

Returns Promise<Client>

Settings

On This Page

`Static`connect