# hot-restart

**Repository Path**: mirrors_node-modules/hot-restart

## Basic Information

- **Project Name**: hot-restart
- **Description**: hot restart node server in cluster mode
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

hot-restart
------------

[![NPM version](https://badge.fury.io/js/hot-restart.svg)](http://badge.fury.io/js/hot-restart)
[![Build Status](https://travis-ci.org/node-modules/hot-restart.svg?branch=master)](https://travis-ci.org/node-modules/hot-restart)

hot restart a node server in cluster mode.

## Install

```
npm install hot-restart
```

## Usage

in master:

```
var restarter = require('hot-restart')();

restarter.on('restart', fuction () {
  // fork new workers
});

// when new work forked
restarter.add(newWorker);

// when old work died
restarter.remove(oldWorker);
```

in worker:

```
var restarter = require('hot-restart/worker');

restarter({
  disconnectTime: 1000,
  exitTime: 2000
});
```

use signal to hot restart the server: `kill -PIPE 3132`

checkout the [example](example).

## Flow

1. in master, `require('restarter')(opts)`, and add every worker to `restarter`.
2. in workers, `require('restarter/worker')(opts)`, set disconnect options.
3. `kill -PIPE 3132` to tell master restart.
4. master will send restart message to all workers, then emit `restart` event,
user need to start some new workers manually(also need to add these new works to restarter).
5. old workers got restart message, will disconnect after `disconnectTime` and
exit after `exitTme`.


## License

MIT