overtake 0.0.1-rc2 → 0.0.1-rc3

package/README.md

@@ -55,7 +55,7 @@ benchmark('mongodb vs postgres', () => {
     return { postgres, mongo };
   });
 
-  measure('mongodb inserts', ({ mongo }/* context */, next) => {
+  measure('mongodb inserts', ({ mongo } /* context */, next) => {
     // prepare a collection
     const database = mongo.db('overtake');
     const test = database.collection('test');
@@ -63,21 +63,19 @@ benchmark('mongodb vs postgres', () => {
     return (data) => test.insertOne(data).then(next);
   });
 
-  measure('postgres inserts', ({ postgres }/* context */, next) => {
+  measure('postgres inserts', ({ postgres } /* context */, next) => {
     // prepare a query
     const query = 'INSERT INTO overtake(value) VALUES($1) RETURNING *';
 
     return (data) => postgres.query(query, [data.value]).then(next);
   });
 
-  teardown(({ mongo, postgres }) => {
-    await postgres.end()
-    await mongo.end()
+  teardown(async ({ mongo, postgres }) => {
+    await postgres.end();
+    await mongo.end();
   });
 
-  perform('simple test', 100000, [
-    { value: 'test' },
-  ]);
+  perform('simple test', 100000, [[{ value: 'test' }]]);
 });
 ```
 
@@ -87,6 +85,12 @@ Make sure you have installed used modules and run
 yarn overtake
 ```
 
+or
+
+```bash
+npx overtake
+```
+
 Please take a look at [benchmarks](__benchmarks__) to see more examples
 
 ## License

package/index.d.ts

@@ -0,0 +1,82 @@
+import { Event } from 'evnty';
+
+declare global {
+  type CanBePromise<T> = Promise<T> | T;
+
+  interface Report {
+    type: string;
+    success: boolean;
+    count: number;
+    min: number;
+    max: number;
+    sum: number;
+    avg: number;
+    med: number;
+    mode: number;
+    p90: number;
+    p95: number;
+    p99: number;
+    setup: number;
+    init: number;
+    cycles: number;
+    teardown: number;
+    total: number;
+  }
+
+  interface Overtake {
+    onLoad: Event<any>;
+
+    onRun: Event<any>;
+
+    onComplete: Event<any>;
+
+    onScriptRegister: Event<any>;
+
+    onScriptStart: Event<any>;
+
+    onScriptComplete: Event<any>;
+
+    onSuiteRegister: Event<any>;
+
+    onSuiteStart: Event<any>;
+
+    onSuiteComplete: Event<any>;
+
+    onSetupRegister: Event<any>;
+
+    onTeardownRegister: Event<any>;
+
+    onMeasureRegister: Event<any>;
+
+    onMeasureStart: Event<any>;
+
+    onMeasureComplete: Event<any>;
+
+    onPerformRegister: Event<any>;
+
+    onPerformStart: Event<any>;
+
+    onPerformProgress: Event<any>;
+
+    onPerformComplete: Event<any>;
+
+    onReport: Event<Report>;
+  }
+
+  function benchmark(title: string, init: () => void): void;
+
+  function setup<C>(init: () => CanBePromise<C>): any;
+
+  function teardown<C>(teardown: (context: C) => CanBePromise<void>): void;
+
+  type MeasureInitResult = CanBePromise<() => void>;
+
+  function measure(title: string, init: () => MeasureInitResult): void;
+  function measure(title: string, init: (next: () => void) => MeasureInitResult): void;
+  function measure<C>(title: string, init: (context: C, next: () => void) => MeasureInitResult): void;
+  function measure<C, A>(title: string, init: (context: C, args: A, next: () => void) => MeasureInitResult): void;
+
+  function perform<A>(title: string, counter: number, args: A): void;
+
+  function reporter(reporter: (overtake: Overtake) => void): void;
+}

package/index.js

@@ -40,8 +40,6 @@ export class Suite {
 
   teardown = NOOP;
 
-  #title = '';
-
   #init = NOOP;
 
   #overtake = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "overtake",
-  "version": "0.0.1-rc2",
+  "version": "0.0.1-rc3",
   "description": "NodeJS performance benchmark",
   "main": "index.js",
   "types": "index.d.ts",