TinyTick logoTinyTick

addRunningTaskRunIdsListener

The addRunningTaskRunIdsListener method.

addRunningTaskRunIdsListener(listener: TaskRunIdsListener): string
TypeDescription
listenerTaskRunIdsListener

The function that will be called whenever the list of running task run Ids changes.

returnsstring

A unique Id for the listener that can later be used to remove it.

The provided listener is a TaskRunIdsListener function, and will be called with a reference to the Manager.

Example

This example registers a listener that responds to task runs starting and completing.

import {createManager} from 'tinytick';

const manager = createManager().start();
manager.setTask('ping', async () => await fetch('https://example.org'));

const listenerId = manager.addRunningTaskRunIdsListener((manager) =>
  console.log(manager.getRunningTaskRunIds().length + ' running Ids'),
);

manager.scheduleTaskRun('ping');
// ... wait 150ms for task to start
// -> '1 running Ids'
// ... wait 150ms again for task to complete
// -> '0 running Ids'

manager.delListener(listenerId);

Since

v1.2.0