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

pid-async-class

v1.1.1

Published

##Exports Exports static function nEw, BaseAsync class, and ScheduledAsync class

Downloads

23

Readme

pid-async-class

##Exports Exports static function nEw, BaseAsync class, and ScheduledAsync class

##Usage

###Basic

var nEw = require("pid-async-class").nEw;
var BaseAsync = require("pid-async-class").BaseAsync;

class MyClass extends BaseAsync{
  constructor(){
    super();
  }

  myFunc(x){
    return x + 1
  }
}

var myInstance = await nEw(MyClass);

var [status, returnValue] = await myInstance.a(["myFunc", 1]);
  //status === "OK"
  //returnValue === 2

###Basic schedule You can add scheduled executions with the schedule function. Multiple schedules are allowed.

var nEw = require("pid-async-class").nEw;
var ScheduledAsync = require("pid-async-class").ScheduledAsync;

class MyClass extends ScheduledAsync{
  constructor(suffix){
    super();
    this.suffix = suffix;
  }

  myLog(message){
    console.log(message + this.suffix);
  }
}

var myInstance = await nEw(MyClass, "World");

//Cron format
myInstance.schedule("*/1 * * * * *", "myLog", ["Hello "]);

//Milliseconds format
myInstance.schedule(1000, "myLog", ["Hello "]);

//This will perform the myLog with message 'Hello World' function every second

###Proxy schedule Similar to Schedule Class but only requires an existing class instance and not inheritance, you can swap instances at runtime.

var nEw = require("pid-async-class").nEw;
var ProxyAsync = require("pid-async-class").ProxyAsync;

class MyClass {
  constructor(suffix){
    super();
    this.suffix = suffix;
  }

  myLog(message){
    console.log(message + this.suffix);
  }
}

var myInstance = new MyClass("World");

var myProxy = await nEw(ProxyAsync, myInstance);

//Cron format
myProxy.schedule("*/1 * * * * *", "myLog", ["Hello "]);

//Milliseconds format
myProxy.schedule(1000, "myLog", ["Hello "]);

//This will perform the myLog with message 'Hello World' function every second
class MyClass2{
  constructor(suffix){
    super();
    this.suffix = suffix;
  }

  myLog2(message){
    console.log(message + this.suffix);
  }
}

myProxy.cancelAll();
//Swap Instances at runtime!!! (remember to cancel previous schedules)
myProxy.swapInstance(new MyClass2("World"));

##API

###function nEw(ClassFn, ...params) -> Promise<Class_Instance> Returns a promise that will return the class upon complete construction, params will be inputed into the constructor function.

###class BaseAsync

####function a([methodName, ...params]) -> Promise<[status, returnValue]>

invokes a method asynchronously on the class in the classes subprocess. The class subprocess can only invoke one 'a' method at a time. Other 'a' calls will queue up.

####function aPass([methodName, ...params]) -> Promise<[status, returnValue]>

invokes a method asynchronously on the class in its own subprocess. Multiple can run at the same time.

###class ScheduledAsync extends BaseAsync

####function schedule(CronString or number(milliseconds), methodName, Array Params) -> undefined

Invokes the method according to the cron string or number, with params. Note this will perform only one scheduled task at a time. Others will wait in a queue until the class process is open.

####function scheduleSimul(CronString or number(milliseconds), methodName, Array Params) -> undefined

Invokes the method according to the cron string or number, with params. Note this will perform the scheduled tasks in their own coroutine so concurrent scheduled tasks can occur.

####function cancel(methodName, CronString or number(milliseconds)) -> undefined

Will cancel the scheduled task given the methodName and matching CronString or number

####function cancelAll() -> undefined

Will cancelAll the scheduled tasks