Performance test your functions
Wedgetail is a small performance tesing library that runs on NodeJS
9.5.0 and above. It's designed
to be used inside your tests, to ensure your desired function is always as fast as you want it to be.
wedgetail to your
yarn add -D wedgetail
npm install --save-dev wedgetail
Wedgetail can be easily inserted into your tests. It's reccomended you create a seperate test
just for performance, as you cannot use the result of the function you are testing.
The function you are testing can also be your whole test.
wedgetail you need to call in inside the callback.
// typescript;;test"Can time a function",;
You will need to play around with
numberOfExecutions to find the right number. If your function is
slow (2ms+) you may want to use a number less than 5000.
Running the tests
yarn tests or
npm run tests.
Tests are written with
ava, and we would strongly like tests with any new functionality.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Owen Kelly - ojkelly
This project is licensed under the MIT License - see the LICENSE.md file for details