# qps

**Repository Path**: mirrors_node-modules/qps

## Basic Information

- **Project Name**: qps
- **Description**: High performance qps counter
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

qps
=======

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![Gittip][gittip-image]][gittip-url]
[![David deps][david-image]][david-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/qps.svg?style=flat-square
[npm-url]: https://npmjs.org/package/qps
[travis-image]: https://img.shields.io/travis/node-modules/qps.svg?style=flat-square
[travis-url]: https://travis-ci.org/node-modules/qps
[coveralls-image]: https://img.shields.io/coveralls/node-modules/qps.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/node-modules/qps?branch=master
[gittip-image]: https://img.shields.io/gittip/fengmk2.svg?style=flat-square
[gittip-url]: https://www.gittip.com/fengmk2/
[david-image]: https://img.shields.io/david/node-modules/qps.svg?style=flat-square
[david-url]: https://david-dm.org/node-modules/qps
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/qps.svg?style=flat-square
[download-url]: https://npmjs.org/package/qps

High performance qps counter

## Install

```bash
$ npm install qps
```

## Usage

```js
var QPSCounter = require('qps');

var counter = new QPSCounter();

// plus one
counter.plus();

// current qps
counter.get();
```

## API

### QPSCounter(options)

Create a new qps counter with `options`.

- options.listener: a `Function(qpsList)` to get one minute before qps list

```js
var counter = new QPSCounter({
  // get qps list every minute
  listener: function (qpsList) {
    console.log('current process handler qps: %j', qpsList);
    // [85,82,86,90,87,87,88,87,...,88]
  }
});

// plus one when new request arrive
counter.plus();
```

### #plus([count])

Plus one request

```js
// plus one
counter.plus();

// plus more
counter.plus(100);
```

### #get()

Get current requests per second (QPS)

```js
console.log(counter.get());
```

## License

(The MIT License)

Copyright (c) 2014 fengmk2 <fengmk2@gmail.com> and other contributors

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.