Module @stablelib/benchmark

Index

Interfaces

Results

Functions

Functions

benchmark

benchmark(fn: () => any, bytes?: number): Results

- Defined in benchmark/benchmark.ts:30
Parameters
- fn: () => any
  - - (): any
    - Returns any
- Optional bytes: number
Returns Results

benchmarkAsync

benchmarkAsync(fn: (done: () => void) => any, doneCallback: (results: Results) => void, bytes?: number): void

- Defined in benchmark/benchmark.ts:78
Parameters
- fn: (done: () => void) => any
  - - (done: () => void): any
    - Parameters
      - done: () => void
        (): void
        Returns void
      Returns any
- doneCallback: (results: Results) => void
  - - (results: Results): void
    - Parameters
      - results: Results
      Returns void
- Optional bytes: number
Returns void

benchmarkPromise

benchmarkPromise(fn: () => Promise<any>, bytes?: number): Promise<Results>

- Defined in benchmark/benchmark.ts:127
Parameters
- fn: () => Promise<any>
  - - (): Promise<any>
    - Returns Promise<any>
- Optional bytes: number
Returns Promise<Results>

byteSeq

byteSeq(length: number, start?: number): Uint8Array

- Defined in benchmark/benchmark.ts:173
Returns a Uint8Array of the given length containing sequence of bytes 0, 1, 2 ... 255, 0, 1, 2, ...

If the start byte is given, the sequence starts from it.

Parameters
- length: number
- start: number = 0
Returns Uint8Array

report

report(name: string, results: Results): void

- Defined in benchmark/benchmark.ts:138
Parameters
- name: string
- results: Results
Returns void

Generated using TypeDoc