bench-fps

FPS (frames per second) benchmark utility for perf testing.

npm i bench-fps

pnpm add bench-fps

yarn add bench-fps

Examples

# web

# view source

example/web.ts

import { benchFPS } from 'bench-fps'

describe('perf', () => {
  it('wheeling', async () => {
    const { aggregateStats: aggr } = await benchFPS(3, 4000, x => {
      window.dispatchEvent(
        new WheelEvent('wheel', {
          deltaY: (Math.random() - 0.5) * Math.sin(x * Math.cos(x * 0.5) * 0.05)
            * 250,
        })
      )
    })

    console.table(aggr)

    expect(aggr.min).toBeGreaterThan(15)
    expect(aggr.mean).toBeGreaterThan(58)
    expect(aggr.meanStd).toBeLessThan(1.2)
  })
})

API

# AggregateStats

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L21

# max

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L24

number

# maxStd

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L25

number

# mean

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L28

number

# meanStd

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L29

number

# median

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L26

number

# medianStd

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L27

number

# min

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L22

number

# minStd

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L23

number

# FPSCounter

src/bench-fps.ts#L6

# animFrame

src/bench-fps.ts#L9

number

# fps

src/bench-fps.ts#L7

number []

# lastFrameTime

src/bench-fps.ts#L8

number

# start

src/bench-fps.ts#L10

# ()
()  =>

void

# stop

src/bench-fps.ts#L11

# ()
()  =>

number []

# Stats

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L14

# max

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L16

number

# mean

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L17

number

# median

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L18

number

# min

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L15

number

# std

src/.fastpm/-/everyday-math@0.0.1/dist/types/everyday-math.d.ts#L19

number

# benchFPS(times, iterationDuration, fn)

src/bench-fps.ts#L51

# times

number

# iterationDuration

number

# fn(frame, time)
# frame

number

# time

number

fn(frame, time)  =>

void

benchFPS(times, iterationDuration, fn)  =>

Promise<{
# aggregateStats  =  ...

src/bench-fps.ts#L84

AggregateStats

# stats  =  allStats

src/bench-fps.ts#L83

Stats []

}>

# fpsCounter()

src/bench-fps.ts#L17

fpsCounter()  =>

FPSCounter

Credits

• everyday-math by stagas – Everyday math utilities.
• everyday-utils by stagas – Everyday utilities

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas