Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/mongoose/types/index.d.ts>mongoose

MongoDB object modeling designed to work in an asynchronous environment.
Latest
namespace mongoose
import { mongoose } from "https://deno.land/x/mongoose@6.13.4/types/index.d.ts";

Variables

An array containing all models associated with this Mongoose instance.

The node-mongodb-native driver Mongoose uses.

Mongoose constructor. The exports object of the mongoose module is an instance of this class. Most apps will only use this one instance.

The Mongoose version

Functions

Removes the model named name from the default connection, if it exists. You can use this function to clean up any models you created in your tests to prevent OverwriteModelErrors.

Gets mongoose options

Returns an array of model names created on this instance of Mongoose.

Declares a global plugin executed on all Schemas.

Getter/setter around function for pluralizing collection names.

Sanitizes query filters against query selector injection attacks by wrapping any nested objects that have a property whose name starts with $ in a $eq.

Sets mongoose options

Overwrites the current driver used by this Mongoose instance. A driver is a Mongoose-specific interface that defines functions like find().

Type Aliases

Helper to choose the best option between two type helpers

There may be a better way to do this, but the goal is to return the DocType if it can be infered and if not to return a type which is easily identified as "not valid" so we fall back to "strip out known things added by extending Document" There are three basic ways to mix in Document -- "Document & T", "Document<ObjId, mixins, T>", and "T extends Document". In the last case there is no type without Document mixins, so we can only strip things out. In the other two cases we can infer the type, so we should

Documents returned from queries with the lean option enabled. Plain old JavaScript object documents (POJO).

Update query command to perform on the document