JSPM

  • Created
  • Published
  • Downloads 19022
  • Score
    100M100P100Q136381F
  • License MIT

cluster manager for egg

Package Exports

  • egg-cluster
  • egg-cluster/lib/agent_worker
  • egg-cluster/lib/app_worker
  • egg-cluster/lib/master

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (egg-cluster) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

egg-cluster

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Cluster Manager for Egg


Install

$ npm i egg-cluster --save

Usage

const startCluster = require('egg-cluster').startCluster;
startCluster({
  baseDir: '/path/to/app',
  framework: '/path/to/framework',
});

You can specify a callback that will be invoked when application has started. However, master process will exit when catch an error.

startCluster(options, () => {
  console.log('started');
});

Options

Param Type Description
baseDir String directory of application
framework String specify framework that can be absolute path or npm package
plugins Object plugins for unittest
workers Number numbers of app workers
sticky Boolean sticky mode server
port Number port
https Object start a https server, note: key / cert should be full path to file
require Array|String will inject into worker/agent process
pidFile String will save master pid to this file

Env

EGG_APP_CLOSE_TIMEOUT: app worker boot timeout value

EGG_AGENT_CLOSE_TIMEOUT: agent worker boot timeout value

License

MIT