Class ClientService

The Durable Client service provides methods for starting, signaling, and querying workflows. Start a new workflow execution by calling workflow.start. Note the direct connection to Postgres.

NATS can be used as the message broker if advanced messaging is required (i.e, patterned subscriptions).

Example

//client.ts
import { Client, HotMesh } from '@hotmeshio/hotmesh';
import { Client as Postgres } from 'pg';

async function run(): Promise<string> {
  const client = new Client({
    connection: {
      class: Postgres,
      options: { connectionString: 'postgresql://usr:pwd@localhost:5432/db' }
    }
  });

  const handle = await client.workflow.start({
    args: ['HotMesh'],
    taskQueue: 'default',
    workflowName: 'example',
    workflowId: HotMesh.guid()
  });

  return await handle.result();
  //returns ['Hello HotMesh', '¡Hola, HotMesh!']
}

Properties

workflow

Methods

deployAndActivate hashOptions

Properties

workflow

workflow: ClientWorkflow = ...

The Durable Client service provides methods for starting, signaling, and querying workflows. Starting a workflow is the primary use case and is accessed by calling workflow.start().

Methods

deployAndActivate

  • deployAndActivate(namespace?, version?): Promise<void>

  • Any router can be used to deploy and activate the HotMesh distributed executable to the active quorum EXCEPT for those routers in readonly mode.

    Parameters

    • namespace: string = APP_ID
    • version: string = APP_VERSION

    Returns Promise<void>

hashOptions

Settings

Member Visibility

On This Page

Properties
Methods