Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 2.37 KB

README.md

File metadata and controls

68 lines (53 loc) · 2.37 KB

egg-cluster

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

Cluster Manager for Egg


Install

$ npm i egg-cluster

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
http2 Boolean start a http2 server
typescript Boolean enable loader's typescript support

License

MIT