Skip to content

Commit 57e2b51

Browse files
committed
Add a file comment to the benchmark script
1 parent b90cfb6 commit 57e2b51

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

extensions/ql-vscode/test/benchmarks/jsonl-reader.bench.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
/**
2+
* Benchmarks the jsonl-parser against a reference implementation and checks that it generates
3+
* the same output.
4+
*
5+
* Usage:
6+
*
7+
* ts-node json-reader.bench.ts [evaluator-log.summary.jsonl] [count]
8+
*
9+
* The log file defaults to a small checked-in log and count defaults to 100
10+
* (and should be lowered significantly for large files).
11+
*
12+
* At the time of writing it is about as fast as the synchronous reference implementation,
13+
* but doesn't run out of memory for large files.
14+
*/
115
import { readFile } from "fs-extra";
216
import { readJsonlFile } from "../../src/common/jsonl-reader";
317
import { performance } from "perf_hooks";

0 commit comments

Comments
 (0)