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

pm2-ecosystem

v5.4.3

Published

Type PM2 configuration files. Use JSDoc or the define-app function.

Downloads

70

Readme

pm2-ecosystem

Type-safe PM2 configurations without the pm2 package - quick start

Justification

PM2 does provide TypeScript types out-of-the box.

module.exports = {
  /** @type {import('pm2').StartOptions[]} */
  apps: [{ name: 'app', script: './app.js' }],
};

However, pm2 is not meant to be installed locally.

# Reference https://pm2.keymetrics.io/docs/usage/quick-start/
npm install pm2@latest -g
yarn global add pm2

Since there is no @types/pm2 package, use this instead.

Quick Start

npm i pm2-ecosystem -D
pnpm i pm2-ecosystem -D
// Method 1: Using the `defineApp` function

const { defineApp } = require('pm2-ecosystem');

module.exports = {
  apps: [
    defineApp({ name: 'app1', script: './app1.js' }),
    defineApp({ name: 'app2', script: './app2.js' }),
    // ...
  ],
};

// Method 2: Using JSDoc

module.exports = {
  /** @type {import('pm2-ecosystem').StartOptions[]} */
  apps: [
    { name: 'app1', script: './app1.js' },
    { name: 'app2', script: './app2.js' },
  ],
};

ECMAScript Modules

In a ESM project, the JavaScript configuration file must have the .cjs extension.

| Example Filename | package.json | | ---------------------- | -------------------- | | ecosystem.config.js | "type": "commonjs" | | ecosystem.config.cjs | "type": "module" |

# If the filename is `ecosystem.config.js`
pm2 start # the filename can be omitted.
pm2 start ecosystem.config.js

# If not, the filename must be specified.
pm2 start ecosystem.config.cjs
pm2 start pm2.config.cjs