# mongoose-recurrence

> A mongoose plugin for recurrent events

Latest version **0.2.0** (published 2017-06-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install mongoose-recurrence
pnpm add mongoose-recurrence
yarn add mongoose-recurrence
bun add mongoose-recurrence
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2017-06-23 |
| First published | 2017-05-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kelvne Pechim |
| Maintainers | kelvne |

## Links

- npm: https://www.npmjs.com/package/mongoose-recurrence
- Repository: https://github.com/Kelvne/mongoose-recurrence
- Homepage: https://github.com/Kelvne/mongoose-recurrence#readme
- Issues: https://github.com/Kelvne/mongoose-recurrence/issues
- npm.io page: https://npm.io/package/mongoose-recurrence

## Dependencies (2)

- [rrule](https://npm.io/package/rrule.md) ^2.2.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.4

## Recent versions

- 0.2.0 (latest) — 2017-06-23
- 0.1.3 — 2017-06-02
- 0.1.2 — 2017-05-31
- 0.1.1 — 2017-05-31

## README

# mongoose-recurrence
A mongoose plugin for recurrent events using rrule.js

This is being developed along with an application which is using it. However, this is definitely not production ready. Yet.

## Todo
- README
- Examples
- Github Pages
- Set constants to not be dependent on rrule.js for use
- And a lot of things

## Use

`npm install --save mongoose-recurrence`

```javascript
const recurrence = require('mongoose-recurrence');
const mongoose = require('mongoose');
const Schema = mongoose.Schema;

const EventSchema = new Schema({
  date: Date,
  description: String,
});

EventSchema.plugin(recurrence));

const EventModel = mongoose.model('Event', EventSchema);
```

```javascript
const RRule = require('rrule').RRule;

let eventOne = new EventModel({
  date: new Date(),
  description: String,
});

eventOne = eventOne.addRecurrence({
  freq: RRule.MONTHLY,
});

/**
  eventOne.modifyOne()
  eventOne.modifyAll()
  eventOne.modifyForward()
  eventOne.getInPeriod()
  eventOne.deleteOne()
  eventOne.deleteForward()
*/

```

---
_Source: https://npm.io/package/mongoose-recurrence · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._