Error
Error()
Error.CastError
Error.DivergentArrayError
Error.DocumentNotFoundError
Error.MissingSchemaError
Error.MongooseServerSelectionError
Error.OverwriteModelError
Error.ParallelSaveError
Error.StrictModeError
Error.StrictPopulateError
Error.ValidationError
Error.ValidatorError
Error.VersionError
Error.messages
Error.prototype.name
Error()
Parameters:
msg
«String» Error message
Type:
- «constructor»
Inherits:
MongooseError constructor. MongooseError is the base class for all Mongoose-specific errors.
Example:
const Model = mongoose.model('Test', new mongoose.Schema({ answer: Number }));
const doc = new Model({ answer: 'not a number' });
const err = doc.validateSync();
err instanceof mongoose.Error.ValidationError; // true
Error.CastError
Type:
- «property»
An instance of this error class will be returned when mongoose failed to cast a value.
Error.DivergentArrayError
Type:
- «property»
An instance of this error will be returned if you used an array projection and then modified the array in an unsafe way.
Error.DocumentNotFoundError
Type:
- «property»
An instance of this error class will be returned when save()
fails
because the underlying
document was not found. The constructor takes one parameter, the
conditions that mongoose passed to update()
when trying to update
the document.
Error.MissingSchemaError
Type:
- «property»
Thrown when you try to access a model that has not been registered yet
Error.MongooseServerSelectionError
Type:
- «property»
Thrown when the MongoDB Node driver can't connect to a valid server to send an operation to.
Error.OverwriteModelError
Type:
- «property»
Thrown when a model with the given name was already registered on the connection.
See the FAQ about OverwriteModelError
.
Error.ParallelSaveError
Type:
- «property»
An instance of this error class will be returned when you call save()
multiple
times on the same document in parallel. See the FAQ for more
information.
Error.StrictModeError
Type:
- «property»
Thrown when your try to pass values to model constructor that
were not specified in schema or change immutable properties when
strict
mode is "throw"
Error.StrictPopulateError
Type:
- «property»
An instance of this error class will be returned when mongoose failed to populate with a path that is not existing.
Error.ValidationError
Type:
- «property»
An instance of this error class will be returned when validation failed.
The errors
property contains an object whose keys are the paths that failed and whose values are
instances of CastError or ValidationError.
Error.ValidatorError
Type:
- «property»
A ValidationError
has a hash of errors
that contain individual
ValidatorError
instances.
Example:
const schema = Schema({ name: { type: String, required: true } });
const Model = mongoose.model('Test', schema);
const doc = new Model({});
// Top-level error is a ValidationError, **not** a ValidatorError
const err = doc.validateSync();
err instanceof mongoose.Error.ValidationError; // true
// A ValidationError `err` has 0 or more ValidatorErrors keyed by the
// path in the `err.errors` property.
err.errors['name'] instanceof mongoose.Error.ValidatorError;
err.errors['name'].kind; // 'required'
err.errors['name'].path; // 'name'
err.errors['name'].value; // undefined
Instances of ValidatorError
have the following properties:
kind
: The validator'stype
, like'required'
or'regexp'
path
: The path that failed validationvalue
: The value that failed validation
Error.VersionError
Type:
- «property»
An instance of this error class will be returned when you call save()
after
the document in the database was changed in a potentially unsafe way. See
the versionKey
option for more information.
Error.messages
Type:
- «property»
See:
The default built-in validator error messages.
Error.prototype.name
Type:
- «String»
The name of the error. The name uniquely identifies this Mongoose error. The possible values are:
MongooseError
: general Mongoose errorCastError
: Mongoose could not convert a value to the type defined in the schema path. May be in aValidationError
class'errors
property.DisconnectedError
: This connection timed out in trying to reconnect to MongoDB and will not successfully reconnect to MongoDB unless you explicitly reconnect.DivergentArrayError
: You attempted tosave()
an array that was modified after you loaded it with a$elemMatch
or similar projectionMissingSchemaError
: You tried to access a model withmongoose.model()
that was not definedDocumentNotFoundError
: The document you tried tosave()
was not foundValidatorError
: error from an individual schema path's validatorValidationError
: error returned fromvalidate()
orvalidateSync()
. Contains zero or moreValidatorError
instances in.errors
property.MissingSchemaError
: You calledmongoose.Document()
without a schemaObjectExpectedError
: Thrown when you set a nested path to a non-object value with strict mode set.ObjectParameterError
: Thrown when you pass a non-object value to a function which expects an object as a paramterOverwriteModelError
: Thrown when you callmongoose.model()
to re-define a model that was already defined.ParallelSaveError
: Thrown when you callsave()
on a document when the same document instance is already saving.StrictModeError
: Thrown when you set a path that isn't the schema and strict mode is set tothrow
.VersionError
: Thrown when the document is out of sync