airbnb/hypernova

Document `onServer`?

Open

#73 opened on Jun 20, 2017

View on GitHub
 (2 comments) (1 reaction) (1 assignee)JavaScript (5,831 stars) (249 forks)batch import
documentationhelp wanted

Description

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

Contributor guide

Tech stack
javascriptnodejsexpress
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Node.jsHypernova basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.