airbnb / hypernova

A service for server-side rendering your JavaScript views
MIT License
5.82k stars 208 forks source link

Document `onServer`? #73

Open magicmark opened 7 years ago

magicmark commented 7 years ago

I'm using onServer to be able to hook into express before the batch route is added, so I can do something like this: https://stackoverflow.com/a/21858212/4396258

(Context: we want to just restart workers if they consume too much memory, but specifically at the end of a request so we don't drop drop any requests)

It's either this or adding a workerShouldExit method as a config? What do you think? Can I safely use the onServer method, or is this subject to removal?

(Also on the subject of undocumented arguments - what about documenting context too? It's useful for collecting stats.)

@ljharb @goatslacker

ljharb commented 7 years ago

You'll be able to use it until the next major regardless; hopefully @goatslacker can comment on any long term plans around it.

goatslacker commented 7 years ago

onServer is public API and here to stay. It's how we can have access to app as well as the master process so that we can extend hypernova's server functionality.

👍 on documentation. I'll keep this open.