SchemaTypeOptions

The options defined on a schematype.

Example:

const schema = new Schema({ name: String });
schema.path('name').options instanceof mongoose.SchemaTypeOptions; // true

Allows overriding casting logic for this individual path. If a string, the given string overwrites Mongoose's default cast error message.

Example:

const schema = new Schema({
  num: {
    type: Number,
    cast: '{VALUE} is not a valid number'
  }
});

// Throws 'CastError: "bad" is not a valid number'
schema.path('num').cast('bad');

const Model = mongoose.model('Test', schema);
const doc = new Model({ num: 'fail' });
const err = doc.validateSync();

err.errors['num']; // 'CastError: "fail" is not a valid number'

The default value for this path. If a function, Mongoose executes the function and uses the return value as the default.

If truthy, Mongoose will disallow changes to this path once the document is saved to the database for the first time. Read more about immutability in Mongoose here.

If truthy, Mongoose will build an index on this path when the model is compiled.

The model that populate() should use if populating this path.

If true, attach a required validator to this path, which ensures this path path cannot be set to a nullish value. If a function, Mongoose calls the function and only checks for nullish values if the function returns a truthy value.

Whether to include or exclude this path by default when loading documents using find(), findOne(), etc.

If truthy, Mongoose will build a sparse index on this path.

If truthy, Mongoose will build a text index on this path.

Define a transform function for this individual schema type. Only called when calling toJSON() or toObject().

Example:

const schema = Schema({
  myDate: {
    type: Date,
    transform: v => v.getFullYear()
  }
});
const Model = mongoose.model('Test', schema);

const doc = new Model({ myDate: new Date('2019/06/01') });
doc.myDate instanceof Date; // true

const res = doc.toObject({ transform: true });
res.myDate; // 2019

The type to cast this path to.

If truthy, Mongoose will build a unique index on this path when the model is compiled. The unique option is not a validator.

Function or object describing how to validate this schematype.