airbnb/hypernova

Document `onServer`?

Open

Aperta il 20 giu 2017

Vedi su GitHub
 (2 commenti) (1 reazione) (1 assegnatario)JavaScript (5831 star) (249 fork)batch import
documentationhelp wanted

Descrizione

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

Guida contributor

Tech stack
javascriptnodejsexpress
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Node.jsHypernova basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70
Direzione di ricerca
Examine the source code at src/worker.js to document the onServer and context arguments. Check the Hypernova documentation for existing patterns. Look for any comments from maintainers on the stability of these APIs. Consider adding examples of how to use onServer to hook into Express.