Skip to content

Add documentation for autoRestart flag, specifically that it should be set to false for HMR #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
atassis merged 1 commit into from
Jul 12, 2022
Merged

Add documentation for autoRestart flag, specifically that it should be set to false for HMR #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export default {
name: 'server.js',
nodeArgs: ['--inspect'], // allow debugging
args: ['scriptArgument1', 'scriptArgument2'], // pass args to script
autoRestart: true | false, // Should the script auto-restart after emit. Defaults to true. This should be set to false if using HMR
signal: false | true | 'SIGUSR2', // signal to send for HMR (defaults to `false`, uses 'SIGUSR2' if `true`)
keyboard: true | false, // Allow typing 'rs' to restart the server. default: only if NODE_ENV is 'development'
cwd: undefined | string, // set a current working directory for the child process default: current cwd
Expand Down