mongoose-expiring-schema

A schema plugin that allows documents to have expiration dates, and defaults queries to respect these.

This plugin is meant to be used on a class of documents that is only valid for a certain period of time. That mainly means that the document might have a validFrom date (which means it is only valid AFTER the specific time) and an validUntil date (which means it is only valid until that date). Either of these values can be null, which means the document is valid indefinitely on that end.

When querying for documents that have this plugin, by default, documents will only be returned if they are currently valid.

Getting Started

const ExpiringSchemaPlugin = require('mongoose-expiring-schema');
const ticketSchema = new mongoose.Schema({ concertId: String });

ticketSchema.plugin(ExpiringSchemaPlugin);
const TicketModel = mongoose.model('ticket', ticketSchema);

// Results will only contain tickets that are currently valid
const results = await Model.find().exec();

// Results will only contain tickets that were valid on `someDate`
const results = await Model.find({ validAsOf: someDate }).exec();

• Note that you can use null for validFrom or validUntil to represent that there is no bound on when it starts being valid or when it stops being valid, respectively.

Configuration

• defaultValidFilter: You can specify a function that provides a different default query to determine if documents are valid or not. By default, all currently valid documents come back. The function takes a parameter that is a Date() representing when "now" is for the query.
• get: You can specify a getter function to be used on both validUntil and validFrom.
• set: You can specify a setter function to be used on both validUntil and validFrom.

ExpiringSchemaPlugin contains a constant that has two options in it:

• VALID_FILTERS.CURRENT (default): Queries for docs current valid.
• VALID_FILTERS.CURRENT_AND_FUTURE (default): Queries for docs current or future valid.

Access these via require('mongoose-expiring-schema').VALID_FILTERS.

Installing

npm install mongoose-expiring-schema

Running the tests

Tests written using ava framework. Run them using:

npm test

Deployment

Designed for use in node environments, currently no build process. Supports node 8 and above.

Contributing

Please feel free to fork and submit pull requests

Versioning

We use SemVer for versioning and np for to publish releases.

Authors

• Makinde Adeagbo - makinde (github)

License

This project is licensed under the ISC License - see the LICENSE.md file for details