TinyTick logoTinyTick

delListener

The delListener method removes a listener that was previously added to the Manager.

delListener(listenerId: string): Manager
TypeDescription
listenerIdstring

The Id of the listener to remove.

returnsManager

A reference to the Manager.

Use the Id returned by whichever method was used to add the listener. Note that the Manager may re-use this Id for future listeners added to it.

Example

This example registers a task run listener and then removes it using the delListener method.

import {createManager} from 'tinytick';

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

// Add a listener to track task runs
const listenerId = manager.addTaskRunRunningListener(
  'ping',
  null,
  (manager, taskId, taskRunId, running, reason) =>
    console.log(
      `Task '${taskId}'; running: ${running}, reason: ${reason}`,
    ),
);

// Schedule a task run
manager.scheduleTaskRun('ping');
// -> "Task 'ping'; running: false, reason: 0"

manager.delListener(listenerId);

manager.scheduleTaskRun('ping');
// -> undefined
// The listener is not called.

Since

v1.2.0