Type Alias ExecInput

ExecInput: {
    args: any[];
    entity: string;
    options?: Partial<MeshDataWorkflowOptions>;
}

Executes a remote function by its global entity identifier with specified arguments. If options.ttl is infinity, the function will be cached indefinitely and can only be removed by calling flush. During this time, the function will remain active and can its state can be augmented by calling set, incr, del, etc OR by calling a transactional 'hook' function.

Type declaration

  • args: any[]

    the function's input arguments

    Example

    ['Jane', 'Doe']
  • entity: string

    the connected function's entity identifier

    Example

    user
  • Optionaloptions?: Partial<MeshDataWorkflowOptions>

    Extended options for the hook function, like specifying a taskQueue or ttl

    Example

    { ttl: '5 minutes' }

Template: T

The expected return type of the remote function.

Settings

Member Visibility