npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mezzy/progress

v0.1.180

Published

A luxurious user experience framework, developed by your friends at Mezzanine.

Downloads

1

Readme

progress

An asynchronous progress tracker with detailed reporting.

  • Supports customizable commands.
  • Nested command queues.
  • Progress steps can be individually weighted.

Install

npm install @mezzy/progress

Use

Queue and run commands

import {ProgressCommand, ProgressReport, ProgressTracker} from '@mezzy/progress';

/// Instantiate our progress tracker.
let progress:ProgressTracker = new ProgressTracker();

/// Queue up our first command.
progress.queue(
    (args:ProgressRunArgs, lastProgressCommandReturnValue:any, ...runArgs:any[]) => {
        /// This command just logs a message to the console.
        Debug.info('Progress Command 01');

        /// Queue up a sub-command.
        args.queue(
            (args:ProgressRunArgs, lastProgressCommandReturnValue:any, ...runArgs:any[]) => {
                Debug.info('Progress Command 01 Sub-command 01');
                args.result.resolve();
            },
            this,
            'Command 01 sub-command 01 running'
        );

        /// This sub-command has a relative weight of 3, so it's expected to take 3
        /// times as long to complete as our first sub-command.
        args.queue(
            (args:ProgressRunArgs, lastProgressCommandReturnValue:any, ...runArgs:any[]) => {
                Debug.info('Progress Command 01 Sub-command 02');
                args.result.resolve();
            },
            this,
            'Command 01 sub-command 02 running',
            3 // relative weight of task (default is 1)
        );

        /// Run our queued sub-commands before continuing with our
        /// top-level commands.
        args.run().then(() => { args.result.resolve(); });
    },
    this,
    'Command 01 running'
);

/// Queue up another top-level command.
progress.queue(
    (args:ProgressRunArgs, lastProgressCommandReturnValue:any, ...runArgs:any[]) => {
        Debug.info('Progress Command 02');

        /// Only 1 sub-command here.
        args.queue(
            (args:ProgressRunArgs, lastProgressCommandReturnValue:any, ...runArgs:any[]) => {
                Debug.info('Progress Command 02 Sub-command 01');
                args.result.resolve();
            },
            this,
            'Command 01 sub-command 01 running'
        );

        args.run().then(() => { args.result.resolve(); });
    },
    this,
    'Command 02 running',
    0.2 // relative weight of task (default is 1)
);

/// Log a message every time a queued command is run and the progress tracker proceeds by 1 step.
progress.progressed.listen((report:ProgressReport) => {
    Debug.log(`step: ${report.stepCurrent}/${report.stepsTotal}, progress: ${report.percent}%`, report.message)
});

/// Let us know when all the commands have been run.
progress.completed.listen(() => {
    Debug.log('Progress completed');
    resolve();
});

progress.run();

Output

output