https://github.com/streammedev/perfnow
A performance.now wrapper for node and browser support
https://github.com/streammedev/perfnow
Last synced: about 1 year ago
JSON representation
A performance.now wrapper for node and browser support
- Host: GitHub
- URL: https://github.com/streammedev/perfnow
- Owner: StreamMeDev
- License: isc
- Created: 2016-08-16T20:02:57.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-12-14T20:06:11.000Z (over 9 years ago)
- Last Synced: 2025-04-03T22:02:16.500Z (about 1 year ago)
- Language: JavaScript
- Size: 7.81 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A `performance.now` wrapper for node and browser support
[](https://npmjs.org/package/@streammedev/perfnow)
[](https://npmjs.org/package/@streammedev/perfnow)
[](https://travis-ci.org/streammedev/perfnow)
[](https://github.com/JedWatson/happiness)
Wraps `performance.now`, `process.hrtime` and `Date.now` to provide a consistent interface for performance timing. This module is
based off [work here](https://github.com/myrne/performance-now) but is not written in coffeescript.
## Install
```
$ npm install --save @streammedev/perfnow
```
## Usage
```javascript
var now = require('@streammedev/perfnow');
var start = now();
setTimeout(function () {
console.log('This operation took ' + (now() - start) + 'ms');
}, 1000);
```
## Development
This package follows semver, when you wish to publish a version run the proper npm command. For example, if we made a bug fix you can do this:
```
$ npm version patch
$ git push
$ npm publish
```
Here are the other types of version bumps:
- Major (`npm version major`): This is for breaking changes. Anytime a method is changed or the functionality is modified this bump should be made.
- Minor (`npm version minor`): This is for features additions. When a new method is added which doesn't affect the behavior of existing features, this bump should be made.
- Patch (`npm version patch`): This is for bug fixes. Only bump this if it is safe for production code to update wihout being QA'd. (AKA, almost never)
For each of these you can run a 'pre' version by prepending to the command, ex `npm version preminor`.
All feature development should be done on a branch off `master`. When a feature is complete and the pull request approved,
publish a 'pre' version of the package for testing across environments. To install that 'pre' version of the package do
the following, where the verison number contains the correct 'pre' version:
```
$ npm install --save @streammedev/perfnow@1.0.0-0
```
Running the tests:
```
$ npm install && npm test
```