Roosevelt

Express browser reloader — changelog

4.0.0

  • Breaking: Forked reload to express-browser-reload which focuses exclusively on the Express use case, as opposed to reload which is a more generalized tool with more features beyond the Express world.
  • Breaking: Altered the architecture to attach the WebSocket server to an existing Express server rather than creating a new server to run alongside it.
  • Breaking: Removed support for some older browsers as well as checks to see if you're running an older browser to simplify the code and make it easier to maintain.
  • Breaking: Removed all params except for route.
  • Added a new param skipDeletingConnections which will skip purging HTTP connections on the Express server when it restarts. If you're already handling this on your Express server yourself, set this param to true to prevent errors.
  • Refactored the code to make it simpler and easier to maintain.
  • Updated dependencies.

Previous updates before the hard fork of reload to express-browser-reload are below. The original project can be found at https://github.com/alallier/reload

3.3.0 / 2024-08-14

Reload command line quality of life enhancements

3.2.2 / 2024-08-12

A bunch of dependency updates and some project maintenance

3.2.1 / 2023-01-02

Happy New Year!

3.2.0 / 2021-06-09

3.1.1 / 2020-09-29

3.1.0 / 2020-06-10

3.0.6 / 2020-06-10

  • Contains the changes from 3.1.0 but was semantically versioned incorrectly. It is recommended not to use this version and upgrade to 3.1.0

3.0.5 / 2020-05-25

3.0.4 / 2019-01-13

3.0.3 / 2019-10-20

3.0.2 / 2019-10-06

3.0.1 / 2019-04-20

Version 3.0.1

Added

Fixed

Updated

3.0.0 / 2019-04-07

Version 3.0.0

Consult Migration Guide for help with updating from Version 2.x to 3.x

Breaking/Removed

  • Removed deprecated parameters (Reload no longer takes the server argument and will error if you provide it)
  • Removed support for Node versions 4, 5, 6, 7, 8, and 9

Breaking/Added

  • Reload now returns a promise
  • Functions in the return API also return promises
    • closerServer
    • startWebSocketServer
  • Reload returns errors in promises

Added

Changed

  • Updates dependencies

Closed these issues

2.4.0 / 2018-12-02

2.3.1 / 2018-08-06

2.3.0 / 2018-06-11

2.2.2 / 2017-08-20

Fixed bug that caused HTML files to not be served when using directory flag (reload command line). See: https://github.com/alallier/reload/pull/139

2.2.1 / 2017-08-05

Fixed regression causing reload command line to only serve HTML files. See: https://github.com/alallier/reload/pull/134

2.2.0 / 2017-07-27

  • Dropped express as a dependency (in reload command line). Reload now uses a vanilla node http server to achieve the same result. This update for the command line offers no changes to the end user and simply modifies the underlying code. See: https://github.com/alallier/reload/pull/132

2.1.0 / 2017-07-25

2.0.1 / 2017-07-20

2.0.0 / 2017-07-09

See V2.0.0 PR https://github.com/alallier/reload/pull/118

Added

  • Added object based parameters (Issue #77 / Originally solved in PR #101 and refactored in #104)
  • Added port configuration (Issue #60 / Originally solved in PR #68 and refactored in #104)
  • Added timestamp to reload command line reloading (Issue #7 / PR #78)
  • Added node 8 support (Issue #106 / PR #119)
  • Added table of contents to README (Issue #103 / PR #105)
  • Added return API to README (PR #121)

Modified

  • Abstracted reload call to an index.js file. Index file now calls reload.js source file. This is to abstract the reload command line calling with a third argument that is now private and not apart of the public API (PR #117)
  • Update dependencies to latest and add package-lock.json files (PR #109)
  • Audited and refactored return API (Issue #120 / PR #121)

Removed

  • Drop support for server and just use ports (Issue #102 / PR #104)
  • Removed support of node 0.1 and 0.12 (Issue #73 / PR #86)
  • Separate server and app initialization into two parts. (This was originally fixed in PR #71 but was reversed in PR #104 when the decision to drop server was made.)

API Breaking Changes

This version makes breaking changes to the reload API. The only required argument to reload now is app. This makes reload a lot easier to use. Reload takes a maximum of two arguments app and an opts (options) object with the following optional parameters, port, route, and verbose. Reload runs on default port 9856 unless otherwise specified in the opts object.

How to upgrade from Version 1 to Version 2

Before Version 2 reload always attached to your server's port by passing the server in a argument to reload. We have now dropped support for server and reload runs on ports only. Reload now has one required parameter app and one optional parameter opts an object of reload options. Below are two upgrade examples for the only two possible 1.x configurations.

Upgrade with required arguments: reload(server, app) becomes reload(app)

Upgrade with both required arguments and the one optional argument: reload(server, app, true) becomes reload(app, {verbose: true})

It is important to note that reload only uses ports now. So upgrading using the examples above will have reload run on it's default port 9856. If you want to run reload on a different port you need to specify a port in the opts object like: reload(app, {port: 9852})

Most people can just use the default settings, allowing reload(app) to work in most cases.

Please refer to the full API in the README.

1.1.7 / 2017-06-28

Repository ownership was transfered from jprichardson to alallier

1.1.6 / 2017-06-18

Add Mac building in Travis. See https://github.com/jprichardson/reload/pull/98

1.1.5 / 2017-05-13

Fixed standard call so that our bin file also got tested. See https://github.com/jprichardson/reload/pull/85

1.1.4 / 2017-05-13

Added AppVeyor to build our tests in an Windows environment. See https://github.com/jprichardson/reload/pull/92

1.1.3 / 2017-04-28

Upgrade Standard to ~10.0.2 in order for the build to pass node 0.1 and 0.12 Also removed depricated fs.exists and replaced with fs.access See: https://github.com/jprichardson/reload/pull/75

1.1.2 / 2017-04-16

Fix multiple websockets at once when using reload.reload(); See: https://github.com/jprichardson/reload/pull/57

1.1.1 / 2017-01-28

Fixed undefined error log on send message. See: https://github.com/jprichardson/reload/pull/59

1.1.0 / 2016-11-12

Added client end web socket support for https. See: https://github.com/jprichardson/reload/pull/54

1.0.2 / 2016-10-31

Added error handling to websocket send. See: https://github.com/jprichardson/reload/pull/49

1.0.1 / 2016-07-15

Fixed onbeforeunload event not firing in reload-client See: https://github.com/jprichardson/reload/pull/46

1.0.0 / 2016-06-24

Added

  • Two new badges to the README (code-style and npm version)
  • Verbose mode as option for both Express and command line usage
  • A sample app for express

Modified

  • Re-wrote the README to reflect all of these changes
  • Updated dependencies to their latest version’s
  • Fixed race condition that caused reload to spam the server when using sockets for automatic reloading

Removed

  • All delays (wait, normal, and socket) (Reload is now all automatic using web sockets (no delays at all))
  • Client side sockjs web sockets (removed sockjs) (Now using native web sockets on the client side and ws on server side)

See: https://github.com/jprichardson/reload/pull/41

0.8.2 / 2016-06-24

0.8.1 / 2016-06-05

0.8.0 / 2015-12-21

0.7.0 / 2015-10-21

0.6.0 / 2015-10-12

0.5.0 / 2015-09-28

0.4.0 / 2015-08-17

0.3.0 / 2015-07-17

0.2.0 / 2015-06-29

  • Added Express 4 Support

0.1.0 / 2013-09-30

  • silence sockjs
  • created reload bin that is useful for browser/html development

0.0.2 / 2013-03-14

  • fixed bug that caused failure on hashbang urls
  • set proper mime type on reload.js client side script

0.0.1 / 2013-03-13

  • Initial release.