https://github.com/angeal185/socketio-live-reload
in browser live reload using socketIO
https://github.com/angeal185/socketio-live-reload
live-reload nodejs socket-io socketio watch-files
Last synced: about 2 months ago
JSON representation
in browser live reload using socketIO
- Host: GitHub
- URL: https://github.com/angeal185/socketio-live-reload
- Owner: angeal185
- License: mit
- Created: 2018-05-01T10:54:49.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-29T09:37:40.000Z (about 7 years ago)
- Last Synced: 2025-02-09T09:46:29.610Z (over 1 year ago)
- Topics: live-reload, nodejs, socket-io, socketio, watch-files
- Language: JavaScript
- Size: 39.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# socketio-live-reload
in browser live reload using socketIO
### Installation
npm:
```sh
$ npm install socketio-live-reload --save-dev
```
### API
#### server-side
```js
// defaults ~ created in your cwd automatically on
// first run and can be edited in ./SLR.json
{
"server":{ // slr server config
"port": 8888,
"cache": "no-cache"
},
"watch": ["./*"], //watched files
"options": {
"ignored": [ //ignored files
"./node_modules/*"
],
"interval": 100,
"depth": 99,
"ignoreInitial": false,
"followSymlinks": true,
"cwd": "./",
"disableGlobbing": false,
"usePolling": true,
"binaryInterval": 300,
"alwaysStat": false,
"awaitWriteFinish": {
"stabilityThreshold": 2000,
"pollInterval": 100
},
"ignorePermissionErrors": false,
"atomic": 100
},
"io": { //socket.io options
"pingInterval": 10000,
"pingTimeout": 5000,
"transports": [
"polling",
"websocket"
]
}
}
//demo
const slr = require('socketio-live-reload');
slr.init();
```
#### client-side
```js
//defaults
{
port: 8888, // socket.io server port
URL: 'http://localhost', // socket.io server url
reload: true, // auto reload enabled
reloadTime: 1000, // time before reload
debug: true //debug toolbar
}
/**
* sync ~ init SLR
* @param {object} config ~ optional client side config
* @param {function} cb ~ optional callback
**/
slr.init(config, cb)
```
```html
slr.init()
```