Advanced Schemas
diff --git a/docs/api.html b/docs/api.html
index 4a58a537427..03194740366 100644
--- a/docs/api.html
+++ b/docs/api.html
@@ -1,5 +1,5 @@
-Mongoose v8.2.4: Redirect to API
+Mongoose v8.3.1: Redirect to API
Redirecting
diff --git a/docs/api/aggregate.html b/docs/api/aggregate.html
index 8d889db292f..fa2672489e5 100644
--- a/docs/api/aggregate.html
+++ b/docs/api/aggregate.html
@@ -1,4 +1,4 @@
-Mongoose v8.2.4: Aggregate
+Mongoose v8.3.1: Aggregate
Aggregate
+Mongoose v8.3.1: AggregationCursor
AggregationCursor
+Mongoose v8.3.1: Array
Array
+Mongoose v8.3.1: ArraySubdocument
ArraySubdocument
+Mongoose v8.3.1: Buffer
Buffer
+Mongoose v8.3.1: Connection
Connection
+Mongoose v8.3.1: Decimal128
Decimal128
+Mongoose v8.3.1: Document
Document
+Mongoose v8.3.1: DocumentArray
DocumentArray
+Mongoose v8.3.1: Error
Error
+Mongoose v8.3.1: Map
Map
+Mongoose v8.3.1: Model
Model
+Mongoose v8.3.1: Mongoose
Mongoose
+Mongoose v8.3.1: Query
Query
+Mongoose v8.3.1: QueryCursor
QueryCursor
+Mongoose v8.3.1: Schema
Schema
+Mongoose v8.3.1: SchemaArray
SchemaArray
+Mongoose v8.3.1: SchemaArrayOptions
SchemaArrayOptions
+Mongoose v8.3.1: SchemaBoolean
SchemaBoolean
+Mongoose v8.3.1: SchemaBuffer
SchemaBuffer
+Mongoose v8.3.1: SchemaBufferOptions
SchemaBufferOptions
+Mongoose v8.3.1: SchemaDateOptions
SchemaDateOptions
+Mongoose v8.3.1: SchemaDocumentArray
SchemaDocumentArray
+Mongoose v8.3.1: SchemaNumber
SchemaNumber
+Mongoose v8.3.1: SchemaNumberOptions
SchemaNumberOptions
+Mongoose v8.3.1: SchemaObjectId
SchemaObjectId
+Mongoose v8.3.1: SchemaObjectIdOptions
SchemaObjectIdOptions
+Mongoose v8.3.1: SchemaString
SchemaString
+Mongoose v8.3.1: SchemaStringOptions
SchemaStringOptions
+Mongoose v8.3.1: SchemaSubdocument
SchemaSubdocument
+Mongoose v8.3.1: SchemaType
SchemaType
SchemaType()SchemaType.cast()SchemaType.checkRequired()SchemaType.get()SchemaType.prototype.cast()SchemaType.prototype.castFunction()SchemaType.prototype.default()SchemaType.prototype.doValidate()SchemaType.prototype.get()SchemaType.prototype.immutable()SchemaType.prototype.index()SchemaType.prototype.isRequiredSchemaType.prototype.pathSchemaType.prototype.ref()SchemaType.prototype.required()SchemaType.prototype.select()SchemaType.prototype.set()SchemaType.prototype.sparse()SchemaType.prototype.text()SchemaType.prototype.transform()SchemaType.prototype.unique()SchemaType.prototype.validate()SchemaType.prototype.validatorsSchemaType.set()
SchemaType()
Parameters:
path+})();SchemaType()SchemaType.cast()SchemaType.checkRequired()SchemaType.get()SchemaType.prototype.cast()SchemaType.prototype.castFunction()SchemaType.prototype.default()SchemaType.prototype.doValidate()SchemaType.prototype.get()SchemaType.prototype.immutable()SchemaType.prototype.index()SchemaType.prototype.isRequiredSchemaType.prototype.pathSchemaType.prototype.ref()SchemaType.prototype.required()SchemaType.prototype.select()SchemaType.prototype.set()SchemaType.prototype.sparse()SchemaType.prototype.text()SchemaType.prototype.transform()SchemaType.prototype.unique()SchemaType.prototype.validate()SchemaType.prototype.validateAll()SchemaType.prototype.validatorsSchemaType.set()
SchemaType()Parameters:
path«String»[options]«SchemaTypeOptions» See SchemaTypeOptions docs[instance]@@ -330,7 +330,7 @@Example:
Suppose you are implementing user registration for a website. Users provide an email and password, which gets saved to mongodb. The email is a string that you will want to normalize to lower case, in order to avoid one email -having more than one account -- e.g., otherwise, avenue@q.com can be registered for 2 accounts via avenue@q.com and AvEnUe@Q.CoM.
+having more than one account -- e.g., otherwise, avenue@q.com can be registered for 2 accounts via avenue@q.com and AvEnUe@Q.CoM.You can set up email lower case normalization easily via a Mongoose setter.
function toLower(v) { return v.toLowerCase(); @@ -492,7 +492,7 @@Error message templates:
the validator throws, do this:
@@ -523,6 +523,9 @@schema.path('name').validate({ validator: function() { throw new Error('Oops!'); }, - // `errors['name']` will be "Oops!" + // `errors['name'].message` will be "Oops!" message: function(props) { return props.reason.message; } });Asynchronous validation:
+// registering an error listener on the Model lets us handle errors more locally Product.on('error', handleError);
SchemaType.prototype.validateAll()Parameters:
validators+«Array<RegExp|Function|Object>»
Adds multiple validators for this document path. +Calls
validate()for every element in validators.SchemaType.prototype.validatorsType:
- «property»
The validators that Mongoose should run to validate properties at this SchemaType's path.
Example:
const schema = new Schema({ name: { type: String, required: true } }); diff --git a/docs/api/schematypeoptions.html b/docs/api/schematypeoptions.html index 48392d2ce47..d0146c1a519 100644 --- a/docs/api/schematypeoptions.html +++ b/docs/api/schematypeoptions.html @@ -1,4 +1,4 @@ -Mongoose v8.2.4: SchemaTypeOptions