lib: add `node:bench` explicit createRunner · nodejs/node@4b9b53f · GitHub
Skip to content

Commit 4b9b53f

Browse files
jasnelladuh95
authored andcommitted
lib: add node:bench explicit createRunner
Makes it easier for benchmark tools to build on top of the bench runner primitives. Signed-off-by: James M Snell <jasnell@gmail.com> Assisted-by: Opencode PR-URL: #65606 Reviewed-By: Filip Skokan <panva.ip@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day>
1 parent 14613fd commit 4b9b53f

14 files changed

Lines changed: 805 additions & 75 deletions

‎doc/api/bench.md‎

Lines changed: 147 additions & 16 deletions

‎doc/api/cli.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -539,8 +539,9 @@ added: REPLACEME
539539

540540
> Stability: 1 - Experimental
541541
542-
Overrides the number of measured callback invocations for every selected
543-
benchmark. `count` must be an integer between `1` and `4294967295`.
542+
Overrides the maximum number of measured callback invocations for every
543+
selected benchmark. A benchmark may finish earlier by calling
544+
`context.done()`. `count` must be an integer between `1` and `4294967295`.
544545

545546
### `--bench-warmup=count`
546547

‎doc/node.1‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,8 +323,9 @@ have a corresponding \fB--bench-reporter-destination\fR. The default reporter is
323323
\fBspec\fR.
324324
.
325325
.It Fl -bench-samples Ns = Ns Ar count
326-
Overrides the number of measured callback invocations for every selected
327-
benchmark. \fBcount\fR must be an integer between \fB1\fR and \fB4294967295\fR.
326+
Overrides the maximum number of measured callback invocations for every
327+
selected benchmark. A benchmark may finish earlier by calling
328+
\fBcontext.done()\fR. \fBcount\fR must be an integer between \fB1\fR and \fB4294967295\fR.
328329
.
329330
.It Fl -bench-warmup Ns = Ns Ar count
330331
Overrides the number of unreported warmup callback invocations for every

‎lib/bench.js‎

Lines changed: 5 additions & 1 deletion

0 commit comments

Comments
 (0)