https://github.com/eugenehp/react-native-benchmark
React Native benchmarking library inspired by benchmark.js and written in TypeScript.
https://github.com/eugenehp/react-native-benchmark
android benchmark ios performance react-native typescript
Last synced: 16 days ago
JSON representation
React Native benchmarking library inspired by benchmark.js and written in TypeScript.
- Host: GitHub
- URL: https://github.com/eugenehp/react-native-benchmark
- Owner: eugenehp
- License: mit
- Created: 2021-04-18T02:15:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-18T06:09:44.000Z (about 4 years ago)
- Last Synced: 2025-05-27T17:47:46.809Z (about 2 months ago)
- Topics: android, benchmark, ios, performance, react-native, typescript
- Language: TypeScript
- Homepage: https://github.com/eugenehp/react-native-benchmark#readme
- Size: 56.6 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# react-native-benchmark
[](./LICENSE)
[](https://www.npmjs.com/package/react-native-benchmark)
[](https://npmcharts.com/compare/react-native-benchmark?minimal=true)
[](https://npmcharts.com/compare/react-native-benchmark?minimal=true)
[](https://github.com/eugenehp/react-native-benchmark/watchers)
[](https://github.com/eugenehp/react-native-benchmark/stargazers)
[](https://github.com/eugenehp/react-native-benchmark/network/members)
[](https://github.com/eugenehp/react-native-benchmark/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Abug)
[](https://github.com/eugenehp/react-native-benchmark/issues)
[](https://github.com/eugenehp/react-native-benchmark/pulls)
[](https://packagephobia.com/result?p=react-native-benchmark)
[](https://bundlephobia.com/[email protected])
React Native benchmarking library inspired by [benchmark.js](https://github.com/bestiejs/benchmark.js) and written in TypeScript.
**Warning**: This library is work in progess. Use it at your own risk!
## Installation
```shell
npm i -s benchmark-ts
```
## Usage
```Typescript
// example/index.ts
import { EventType, Suite } from "../src";
const suite = new Suite;
suite.add('RegExp#test', () => {
/o/.test('Hello World!');
})
.add('String#indexOf', () => {
'Hello World!'.indexOf('o') > -1;
})
.add('String#match', () => {
!!'Hello World!'.match(/o/);
})
.on(EventType.CYCLE, (event) => {
// console.log(event.type, event.target.times);
})
.on(EventType.COMPLETE, (event) => {
// const s:Suite = event.target as Suite
console.log(suite.toString())
})
.run({async: true});
```
## Example output
Output for `suite.toString()` method.
```plain
RegExp#test - 2211577 ops/sec ± 2.10%
String#indexOf - 2335987 ops/sec ± 1.96%
String#match - 2046868 ops/sec ± 0.88%
```
Output for `suite.toJSON()` method.
```JSON
{
'RegExp#test': {
moe: 46334.779732633404,
mean: 2211577.4,
rme: 2.0951009778194245,
deviation: 37322.66469908063,
variance: 1392981300.2399998,
sem: 16691.203073715205,
sample: [ 2138299, 2234914, 2228720, 2217517, 2238437 ]
},
'String#indexOf': {
moe: 45836.23559201627,
mean: 2335986.6,
rme: 1.962178875170614,
deviation: 36921.08739785436,
variance: 1363166694.6399999,
sem: 16511.612244962635,
sample: [ 2265366, 2353147, 2372154, 2338449, 2350817 ]
},
'String#match': {
moe: 18031.048282470998,
mean: 2046867.8,
rme: 0.880909274280977,
deviation: 14524.009245384002,
variance: 210946844.56,
sem: 6495.33439570281,
sample: [ 2048837, 2035629, 2025664, 2064410, 2059799 ]
}
}
```
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## Sponsorship
Thank you to our sponsors:
[
](https://www.reactivelions.com)
## License
[MIT](./LICENSE)
Copyright (c) 2021 Eugene Hauptmann