`addScheduledTaskRunIdsListener`

The addScheduledTaskRunIdsListener method registers a listener function with the Manager that will be called whenever its list of scheduled task run Ids changes.

addScheduledTaskRunIdsListener(listener: TaskRunIdsListener): string

Type Description

	Type	Description
`listener`	`TaskRunIdsListener`	The function that will be called whenever the list of scheduled task run `Ids` changes.
returns	`string`	A unique `Id` for the listener that can later be used to remove it.

listener

TaskRunIdsListener

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

returns

string

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 new task runs being scheduled.

import {createManager} from 'tinytick';

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

const listenerId = manager.addScheduledTaskRunIdsListener((manager) => {
  console.log(manager.getScheduledTaskRunIds().length + ' scheduled Ids');
});

manager.scheduleTaskRun('ping', '', 200);
// -> '1 scheduled Ids'
manager.scheduleTaskRun('ping', '', 400);
// -> '2 scheduled Ids'

manager.delListener(listenerId);

Since

v1.2.0