Skip to content

Commit

Permalink
Add a file comment to the benchmark script
Browse files Browse the repository at this point in the history
  • Loading branch information
asgerf committed Nov 20, 2024
1 parent b90cfb6 commit 57e2b51
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions extensions/ql-vscode/test/benchmarks/jsonl-reader.bench.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
/**
* Benchmarks the jsonl-parser against a reference implementation and checks that it generates
* the same output.
*
* Usage:
*
* ts-node json-reader.bench.ts [evaluator-log.summary.jsonl] [count]
*
* The log file defaults to a small checked-in log and count defaults to 100
* (and should be lowered significantly for large files).
*
* At the time of writing it is about as fast as the synchronous reference implementation,
* but doesn't run out of memory for large files.
*/
import { readFile } from "fs-extra";
import { readJsonlFile } from "../../src/common/jsonl-reader";
import { performance } from "perf_hooks";
Expand Down

0 comments on commit 57e2b51

Please sign in to comment.