docs: expand API reference to address issue #49#221
Conversation
Documents the plugin-facing tap options (name, stage, before), the hook-owner protected API, the full set of interceptor handlers (error, result, done, name), withOptions, and adds a Code generation section explaining the runtime compilation and evals used by hooks. Also clarifies HookMap for vs get and MultiHook semantics. Refs #49
Adds four small snippets showing how MultiHook fans taps out to multiple hooks, how tapAsync/tapPromise are forwarded, how intercept/withOptions attach to a group of hooks at once, and how isUsed aggregates across the wrapped hooks. Refs #49
Shows how pre-configuring stage via withOptions orders taps, and notes that per-tap options override values from the facade. Refs #49
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #221 +/- ##
=======================================
Coverage 97.96% 97.96%
=======================================
Files 13 13
Lines 689 689
Branches 112 112
=======================================
Hits 675 675
Misses 13 13
Partials 1 1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2 participants
fixes #49