SchemaBoolean

布林值 SchemaType 建構子。

覆寫 required 驗證器用來檢查布林值是否通過 required 檢查的函式。

設定哪些值會被轉換為 false。

範例

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

設定哪些值會被轉換為 true。

範例

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

為所有布林值實例附加一個 getter

範例

mongoose.Schema.Boolean.get(v => v === true ? 'yes' : 'no');

const Order = mongoose.model('Order', new Schema({ isPaid: Boolean }));
new Order({ isPaid: false }).isPaid; // 'no'

取得/設定用於將任意值轉換為布林值的函式。

範例

// 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);

檢查給定的值是否滿足 required 驗證器。對於要滿足 required 驗證器的布林值，它必須嚴格等於 true 或 false。

此 schema type 的名稱，以防止縮小器混淆函式名稱。

為所有布林值實例設定一個預設選項。

範例

// 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