Progresssor

A lightweight progress tracking helper.

Table Of Contents

• Heading
• Table Of Contents
• Installation
• Introduction
• Features
• API
• Usage
• Credits

Installation

npm install progresssor

Introduction

Progresssor is a lightweight helper for tracking the progress of long-running tasks. Mark checkpoints throughout your code, listen for progress updates, and easily display the current progress in your own UI or CLI.

Features

• Lightweight
• Event-driven API
• Progress callbacks
• Completion callback
• Error handling
• Zero dependencies

API

• mark(percent) — Sets the current progress.
• increment(amount) — Increases the current progress.
• decrement(amount) — Decreases the current progress.
• reset() — Resets the current progress and removes all registered listeners.
• get() — Returns the current progress.
• onProgress(callback) ↔ offProgress(callback)
• onComplete(callback) ↔ offComplete(callback)
• onError(callback) ↔ offError(callback)
• offAll() — Removes all registered event listeners.

Usage

offProgress(), offComplete(), and offError() require the same callback function that was previously passed to their corresponding on...() method.

Tip: Import Progresssor using the module format that matches your project.

ES Modules (ESM)

import Progressor from "progresssor/esm";

CommonJS (CJS)

const Progressor = require("progresssor/cjs");

Example

import Progressor from "progresssor/esm";

const progress = new Progressor();

const onProgress = (value) => {
    console.log(`Progress: ${value}%`);
};

const onComplete = () => {
    console.log("Task complete.");
};

const onError = (error) => {
    console.error(error);
};

progress.onProgress(onProgress);
progress.onComplete(onComplete);
progress.onError(onError);

progress.get(); // Returns the current progress as an integer between 0 and 100.

// Some work...
progress.mark(25);
// Sets the current progress to 25%.

progress.increment(5);
// Increases the current progress by 5.
// Current progress: 30%.

progress.decrement(30);
// Decreases the current progress by 30.
// Current progress: 0%.

// Remove a specific listener.
progress.offProgress(onProgress);

// Remove all listeners.
progress.offAll();

// Reset the progress.
progress.reset();
// Resets the current progress back to 0.

// ...

Credits

PFMCODES © 2026 Licensed under MIT License