Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Temporal support in Mongoose

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

mongoose-temporal - Plugin support for temporal types in Mongoose

Overview

Mongoose-Temporal is an extension for Mongoose that implements support for temporal types using the Mongoose ORM.

Installation

npm install mongoose-temporal

Setup

To install all of the types, plugins, patches and utilities provided by the extension into a Mongoose instance:

var mongoose = require("mongoose");

// Create a connection to your database
var db = mongoose.createConnection("mongodb://localhost/sampledb");

// Access the mongoose-temporal module and install everything
var temporal = require("mongoose-temporal");
var utils = temporal.utils

// Install the types, plugins and monkey patches
var loaded = temporal.install(mongoose);

The loaded value returned contains 2 properties:

  • loaded.types : the join types that were loaded
  • loaded.plugins : the extension plugins that were loaded

To just install the types provided by the extension (either all types or a list of named types):

var mongoose = require("mongoose");

// Create a connection to your database
var db = mongoose.createConnection("mongodb://localhost/sampledb");

// Access the mongoose-temporal module
var temporal = require("mongoose-temporal");
var utils = temporal.utils

// Install the plugins
var loaded = temporal.loadTypes(mongoose);

The loaded value returned contains the types that were loaded, keyed by the name of each type loaded.

To just install the plugins provided by the extension (either all plugins or list of named plugins):

var mongoose = require("mongoose");

// Create a connection to your database
var db = mongoose.createConnection("mongodb://localhost/sampledb");

// Access the mongoose-temporal module
var temporal = require("mongoose-temporal");
var utils = temporal.utils

// Install the plugins
var loaded = temporal.installPlugins(mongoose);

The loaded value returned contains the plugins that were loaded, keyed by the name of each plugin loaded.

To just install the patches provided by the extension (either all patches or list of named patches):

var mongoose = require("mongoose");

// Create a connection to your database
var db = mongoose.createConnection("mongodb://localhost/sampledb");

// Access the mongoose-temporal module and the utilities
var temporal = require("mongoose-temporal");
var utils = temporal.utils;

// Install the monkey patches
temporal.installPatches(mongoose);

Contributors

License

MIT License

Acknowledgements

  • Brian Noguchi for the 'mongoose-types' extension that was used as a template for this extension

Author

Stuart Hudson

Something went wrong with that request. Please try again.