Class MeshCall

Connects and links a worker function to the mesh

Example

import * as Redis from 'redis';
import { MeshCall } from '@hotmesh/meshcall';

MeshCall.connect({
  topic: 'my.function',
  connection: {
    class: Redis,
    options: { url: 'redis://:key_admin@redis:6379' }
  },
  callback: async (arg1: any) => {
    //your code here...
  }
});
Copy

Schedules a cron job to run at a specified interval with optional args. Provided arguments are passed to the callback function each time the cron job runs. The id option is used to uniquely identify the cron job, allowing it to be interrupted at any time.

Example

import * as Redis from 'redis';
import { MeshCall } from '@hotmesh/meshcall';

MeshCall.cron({
  topic: 'my.cron.function',
  args: ['arg1', 'arg2'], //optionally pass args
  connection: {
    class: Redis,
    options: { url: 'redis://:key_admin@redis:6379' }
  },
  callback: async (arg1: any, arg2: any) => {
    //your code here...
  },
  options: { id: 'myDailyCron123', interval: '0 0 * * *' }
});
Copy

Calls a function and returns the response.

Example

const response = await MeshCall.exec({
  topic: 'my.function',
  args: [{ my: 'args' }],
  connection: {
    class: Redis,
    options: { url: 'redis://:key_admin@redis:6379' }
  }
});
Copy

Clears a cached function response.

Example

import * as Redis from 'redis';
import { MeshCall } from '@hotmesh/meshcall';

MeshCall.flush({
  topic: 'my.function',
  connection: {
    class: Redis,
    options: { url: 'redis://:key_admin@redis:6379' }
  },
  options: { id: 'myCachedExecFunctionId' }
});
Copy

Interrupts a running cron job. Returns true if the job was successfully interrupted, or false if the job was not found.

Example

import * as Redis from 'redis';
import { MeshCall } from '@hotmesh/meshcall';

MeshCall.interrupt({
  topic: 'my.cron.function',
  connection: {
    class: Redis,
    options: { url: 'redis://:key_admin@redis:6379' }
  },
  options: { id: 'myDailyCron123' }
});
Copy

Shuts down all meshcall instances. Call this method from the SIGTERM handler in your application.