Skip to content

refactor: Updated shim.recordConsume to use shim.record and added ability to invoke an after hook with callback args #2207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 24, 2024
Merged

refactor: Updated shim.recordConsume to use shim.record and added ability to invoke an after hook with callback args #2207

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb7c506
refactor: Updated `shim.recordConsume` to use `shim.record` and added…
bizob2828 May 22, 2024
d023fd0
chore: updated jsdoc for the after function
bizob2828 May 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
chore: updated jsdoc for the after function
  • Loading branch information
@bizob2828
bizob2828 committed May 22, 2024
commit d023fd0317df7bae47b8fc73f90503692309a7f4
17 changes: 10 additions & 7 deletions lib/shim/specs/recorder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,17 @@ const WrapSpec = require('./wrap')
* The instrumented function must have been invoked synchronously.
*
* @typedef {Function} SpecAfterFunction
* @param {object} shim The shim used to instrument the external library.
* @param {Function} fn The function/method from the external library being
* @param {Object} params params to function
* @param {object} params.shim The shim used to instrument the external library.
* @param {Function} params.fn The function/method from the external library being
* instrumented.
* @param {string} name The name of the current function.
* @param {Error|null} error If the instrumented function threw an error, this
* will be that error.
* @param {*} value The result returned by the instrumented function.
* @param {TraceSegment} segment The segment used while instrumenting the
* @param {string} params.name The name of the current function.
* @param {Error|null} [params.error] If the instrumented function threw an error, this
* will be that error. In the case of a callback this will be omitted.
* @param {Array} [params.args] arguments passed to a callback function getting instrumented.
* @param {*} [params.result] The result returned by the instrumented function. In the case of a wrapped
* callback, the data needed is in `params.args`.
* @param {TraceSegment} params.segment The segment used while instrumenting the
* function.
*/

Expand Down