SchemaBoolean

Boolean SchemaType constructor.

Get/set the function used to cast arbitrary values to booleans.

Example:

// Make Mongoose cast empty string '' to false. const original = mongoose.Schema.Boolean.cast(); mongoose.Schema.Boolean.cast(v => { if (v === '') { return false; } return original(v); }); // Or disable casting entirely mongoose.Schema.Boolean.cast(false);

Override the function the required validator uses to check whether a boolean passes the required check.

Configure which values get casted to false.

Example:

const M = mongoose.model('Test', new Schema({ b: Boolean })); new M({ b: 'nay' }).b; // undefined mongoose.Schema.Types.Boolean.convertToFalse.add('nay'); new M({ b: 'nay' }).b; // false

Configure which values get casted to true.

Example:

const M = mongoose.model('Test', new Schema({ b: Boolean })); new M({ b: 'affirmative' }).b; // undefined mongoose.Schema.Boolean.convertToTrue.add('affirmative'); new M({ b: 'affirmative' }).b; // true

Attaches a getter for all Boolean instances

Example:

mongoose.Schema.Boolean.get(v => v === true ? 'yes' : 'no'); const Order = mongoose.model('Order', new Schema({ isPaid: Boolean })); new Order({ isPaid: false }).isPaid; // 'no'

Contains the handlers for different query operators for this schema type. For example, $conditionalHandlers.$in is the function Mongoose calls to cast $in filter operators.

Check if the given value satisfies a required validator. For a boolean to satisfy a required validator, it must be strictly equal to true or to false.

Returns this schema type's representation in a JSON schema.

This schema type's name, to defend against minifiers that mangle function names.

Sets a default option for all Boolean instances.

Example:

// Make all booleans have `default` of false. mongoose.Schema.Boolean.set('default', false); const Order = mongoose.model('Order', new Schema({ isPaid: Boolean })); new Order({ }).isPaid; // false