feat: add mode to fn hooks

[crimx]

Provide a way to check the mode for fn hooks that is consistent with setup and teardown.

[jerome-benoit]

The idea and initial implementation are ok, but lack:

• existing JSDoc update
• documentation update
• dedicated unit tests testing that callbacks mode is respected

Since it's a breaking change in the current PR implementation, a backward compatible implementation should be investigated.

[crimx]

The idea and initial implementation are ok, but lack:

• existing JSDoc update
• documentation update
• dedicated unit tests testing that callbacks mode is respected

Since it's a breaking change in the current PR implementation, a backward compatible implementation should be investigated.

• I noticed the JSDoc artifacts are in the source code. Should I build the JSDoc manually? That would be hard to review.
• There is not existing documentation to update.
• Tests added, just like setup and teardown.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/tinylibs/tinybench@259

commit: 7409c17

[crimx]

I don't see any breaking change? The callbacks are backward compatible. It is unlikely that user passed in a callback with an optional parameter.

[jerome-benoit]

• I noticed the JSDoc artifacts are in the source code. Should I build the JSDoc manually? That would be hard to review.

Since the existing code is not documented, only the public API change should have a JSDoc, so the FnHook type definition should have a typedoc compatible comment.
I will probably add a proper one on Hook type definition.

• There is not existing documentation to update.

I guess a properly commented FnHook type definition should be enough.

[jerome-benoit]

I don't see any breaking change? The callbacks are backward compatible. It is unlikely that user passed in a callback with an optional parameter.

See #259 (comment)

[crimx]

I don't see any breaking change? The callbacks are backward compatible. It is unlikely that user passed in a callback with an optional parameter.

See #259 (comment)

You don't need to make mode optional. Parameters added in callbacks are backward compatible. Playground Link

[jerome-benoit]

See #259 (comment)

You don't need to make mode optional. Parameters added in callbacks are backward compatible. Playground Link

It will fail with strict type checking options enabled.

[crimx]

No I believe it won't. The type would be broken in these two scenarios:

1. If users directly utilize the FnHook type for their definitions, but this type wasn't previously available, so it won't occur.
2. If users provide callbacks with optional parameters, which is unlikely given the context of how opts is used.

But anyway I made the changes as requested, following the Hook signature.

[jerome-benoit]

Thanks !