# mongoose-counters
> Autoincrement counter handling for mongoose
Latest version **1.0.2** (published 2018-08-23) · MIT license · 0 weekly downloads
## Install
```sh
npm install mongoose-counters
pnpm add mongoose-counters
yarn add mongoose-counters
bun add mongoose-counters
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-08-23 |
| First published | 2018-08-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | * |
| Dependencies | 0 |
| Unpacked size | 25.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Gaetano Fiorello |
| Maintainers | t4nz |
| Keywords | mongoose, sequence, autoincrement, counter |
## Links
- npm: https://www.npmjs.com/package/mongoose-counters
- Repository: https://github.com/t4nz/mongoose-counters
- Issues: https://github.com/t4nz/mongoose-counters/issues
- npm.io page: https://npm.io/package/mongoose-counters
## Alternatives
- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads
## Recent versions
- 1.0.2 (latest) — 2018-08-23
- 1.0.1 — 2018-08-17
- 1.0.0 — 2018-08-17
## README
mongoose-counters
=============
This plugin create fields which autoincrement their value every time a new document is inserted in a collection.
[](https://www.npmjs.com/package/mongoose-counters)
[](https://github.com/t4nz/mongoose-counters/blob/master/LICENSE)
[](https://www.codacy.com/app/t4nz/mongoose-counters?utm_source=github.com&utm_medium=referral&utm_content=t4nz/mongoose-counters&utm_campaign=Badge_Grade)
[](https://www.npmjs.com/package/mongoose-counters)
[](https://github.com/ellerbrock/typescript-badges/)
## Installation
---------------
```sh
yarn add mongoose-counters
npm i mongoose-counters
```
## Setup
---------------
This plugin accept a series of options.
- **id**: Id of the counter. Is mandatory only for scoped counters but its use is strongly encouraged.
- **incField**: The name of the field to increment. Mandatory, default is `_id`
- **referenceFields**: The field to reference for a scoped counter. Optional
- **collectionName**: The collection name to mantain the status of the counters. Mandatory, default is `counters`
Use as you would any Mongoose plugin:
```typescript
import * as mongoose from 'mongoose';
import mongooseCounter from 'mongoose-counters';
const counter = mongooseCounter(mongoose);
const schema = new mongoose.Schema({ ... });
schema.plugin(counter, { ...options });
const model = model('MyModel', schema);
```
The increment can be:
- [`global`](#globalCounter): every document has a unique value for the counter field
- [`scoped`](#scopedCounter): the counter depends on the value of other field(s)
### Global counters
Let's say you want to have an `id` field in your `collection` which has an unique auto-incremented value.
The model schema is something like this:
```typescript
ModelSchema = mongoose.Schema({
myAttr: String
...
});
mongoose.model('ModelName', ModelSchema);
```
You don't need to define the `id` field in your schema because the plugin automatically set it for you. The only thing you have to do is to call:
```typescript
ModelSchema.plugin(counter, { incField: 'id' });
```
Every time a new model entry is created, the `id` field will have an incremental number.
If you want to increment the `_id` field which is special to mongoose, you have to explicitly specify it as a Number and tell mongoose to not interfer:
```typescript
ModelSchema = mongoose.Schema({
_id: Number,
myAttr: String
}, { _id: false });
ModelSchema.plugin(AutoIncrement);
```
In this case you don't have to specify `incField` because the default value is `_id`
### Scoped counters
Let say our users are organized for `country` and `city`. And we want to save the `inhabitant_number` according to the two informations.
The schema is like this:
```typescript
UserSchema = mongoose.Schema({
name: String,
country: String,
city: String,
inhabitant_number: Number
});
```
Every time a new Parisian is added the counting of Parisians have to be incremented. The inhabitants of New York must not interfer and have their separated counting. We should define a __scoped__ counter which increment the counter depending on the value of other fields.
```typescript
UserSchema.plugin(AutoIncrement, {id: 'inhabitant_seq', inc_field: 'inhabitant_number', reference_fields: ['country','city'] });
```
Notice that we have to use an id for our sequence, otherwise the plugin will raise an error.
## API
* [`resetCounter()`](#resetCounter)
### resetCounter()
It's possible to programmatically reset a counter through the Model static method `counterReset(id, reference, callback)`. The method take those parameters:
- **id**: the counter to reset. It's mandatory
- **reference**: Let you reset only a specific reference of the counter, if the counter has referenced fields. Optional. By default it reset all the counters for the `id`
- **callback**: A callback which receive an error in case of any. Mandatory
```js
Model.counterReset('the_counter_id', (err) => { ... });
Model.counterReset('the_counter_id', { ref_field_1: 'ref_value_1', ref_field_2: 'ref_value_2'}, (err) => { ... });
```
## Credits
This plugin is inspired by [ramiel/mongoose-sequence](https://github.com/ramiel/mongoose-sequence).
---
_Source: https://npm.io/package/mongoose-counters · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._