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

fork-with-emitter

v3.0.0

Published

Simple EventEmitter wrapper for IPC, enhanced with async .request().

Downloads

282

Readme

fork-with-emitter Build Status

Simple EventEmitter wrapper for IPC, enhanced with async .request().

  • Zero dependencies.
  • TypeScript support.
  • Intuitive naming (fork/host).

Basics

bot.js (fork):

const { host } = require('fork-with-emitter')

host.on('hello', name => {
  console.log(`Hello ${name}`)
})

host.onRequest('getRandomNumber', async () => {
  await sleep(1000)
  return Math.floor(Math.random() * 1000)
})

//returns promise that resolves after given ms
const sleep = ms => 
  new Promise(res => setTimeout(res, ms))

index.js (host):

const { createFork } = require('fork-with-emitter')

const fork = createFork('bot.js')
//pipe fork's console.log to host's console.log
fork.process.stdout.pipe(process.stdout)

fork.emit('hello', 'Artur')

;(async () => {
  const randomNumber = await fork.request('getRandomNumber')
  console.log(randomNumber)

  fork.kill()
})()

Output:

Hello Artur
623

Handling errors

bot.js (fork):

const { host } = require('fork-with-emitter')

host.onRequest('throwError', async () => {
  throw new Error(`Some error message`)
})

index.js (host):

const { createFork } = require('fork-with-emitter')

const fork = createFork('bot.js')

;(async () => {
  try {
    await fork.request('throwError')
  } catch(error) {
    console.log(error)
  }
})()

Output:

Error: Some error message
    at (fork's stack)

Errors and rejections are captured only from .onRequest() handlers.

Exports

{
  /*
    Returns new spawned fork.
  */
  createFork(modulePath, options = { args: [] }),

  /*
    Variable indicating if process is a fork. 
  */
  isForked,

  /*
    Points to host (use those methods from fork).
  */
  host: {
    /*
      process.on('message', listener) with events
    */
    on(event, listener),

    /*
      Listener is removed after execution.
    */
    once(event, listener),

    removeListener(event, listener),

    /*
      process.send(payload) with events
    */
    emit(event, listener),

    /*
      Returned/resolved data from async function will be passed to host's request.  
    */
    onRequest(event, listener),

    onceRequest(event, listener),

    removeRequestListener(event, listener),

    /*
      Returns Promise that resolves with data resolved from host's .onRequest() listener.
      Rejects if response is not sent after 10 seconds.
      maximumTimeout = Infinity -> for very long tasks, not recommended though, because if task stucks and fork still works it causes a memory leak.
    */
    request(event, listener, maximumTimeout = 10)
  }
}

Fork object

Object that points to spawned fork.

{
  /*
    Native ChildProcess object.
  */
  process,

  /*
    Exits process with SIGINT.
  */
  kill(),

  on(event, listener),
  once(event, listener),
  removeListener(event, listener),
  emit(event, listener),
  onRequest(event, listener),
  onceRequest(event, listener),
  removeRequestListener(event, listener),
  request(event, listener, maximumTimeout = 10)
}

License

MIT