mongoose/docs/validation.html at 5.2 · JavaScriptBach/mongoose

History

560 lines (505 loc) · 41.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"><title>Mongoose v5.1.8-pre: Validation</title><link rel="apple-touch-icon" sizes="57x57" href="images/favicon/apple-icon-57x57.png"><link rel="apple-touch-icon" sizes="60x60" href="images/favicon/apple-icon-60x60.png"><link rel="apple-touch-icon" sizes="72x72" href="images/favicon/apple-icon-72x72.png"><link rel="apple-touch-icon" sizes="76x76" href="images/favicon/apple-icon-76x76.png"><link rel="apple-touch-icon" sizes="114x114" href="images/favicon/apple-icon-114x114.png"><link rel="apple-touch-icon" sizes="120x120" href="images/favicon/apple-icon-120x120.png"><link rel="apple-touch-icon" sizes="144x144" href="images/favicon/apple-icon-144x144.png"><link rel="apple-touch-icon" sizes="152x152" href="images/favicon/apple-icon-152x152.png"><link rel="apple-touch-icon" sizes="180x180" href="images/favicon/apple-icon-180x180.png"><link rel="icon" type="image/png" sizes="192x192" href="images/favicon/android-icon-192x192.png"><link rel="icon" type="image/png" sizes="32x32" href="images/favicon/favicon-32x32.png"><link rel="icon" type="image/png" sizes="96x96" href="images/favicon/favicon-96x96.png"><link rel="icon" type="image/png" sizes="16x16" href="images/favicon/favicon-16x16.png"><link rel="stylesheet" href="https://unpkg.com/[email protected]/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous"><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans"><link rel="stylesheet" href="/docs/css/github.css"><link rel="stylesheet" href="/docs/css/mongoose5.css"><link rel="apple-touch-icon" sizes="57x57" href="images/favicon/apple-icon-57x57.png"><link rel="apple-touch-icon" sizes="60x60" href="images/favicon/apple-icon-60x60.png"><link rel="apple-touch-icon" sizes="72x72" href="images/favicon/apple-icon-72x72.png"><link rel="apple-touch-icon" sizes="76x76" href="images/favicon/apple-icon-76x76.png"><link rel="apple-touch-icon" sizes="114x114" href="images/favicon/apple-icon-114x114.png"><link rel="apple-touch-icon" sizes="120x120" href="images/favicon/apple-icon-120x120.png"><link rel="apple-touch-icon" sizes="144x144" href="images/favicon/apple-icon-144x144.png"><link rel="apple-touch-icon" sizes="152x152" href="images/favicon/apple-icon-152x152.png"><link rel="apple-touch-icon" sizes="180x180" href="images/favicon/apple-icon-180x180.png"><link rel="icon" type="image/png" sizes="192x192" href="images/favicon/android-icon-192x192.png"><link rel="icon" type="image/png" sizes="32x32" href="images/favicon/favicon-32x32.png"><link rel="icon" type="image/png" sizes="96x96" href="images/favicon/favicon-96x96.png"><link rel="icon" type="image/png" sizes="16x16" href="images/favicon/favicon-16x16.png"><link rel="manifest" href="images/favicon/manifest.json"><meta name="msapplication-TileColor" content="#ffffff"><meta name="msapplication-TileImage" content="images/favicon/ms-icon-144x144.png"><meta name="theme-color" content="#ffffff"></head><body><div id="layout"><div id="mobile-menu"><a id="menuLink" href="#menu" class="menu-link"></a><div id="mobile-logo-container"><a href="/"><img id="logo" src="/docs/images/mongoose5_62x30_transparent.png">mongoose</a></div></div><div id="menu"><div class="pure-menu"><div id="logo-container" class="pure-menu-heading"><a href="/"><img id="logo" src="/docs/images/mongoose5_62x30_transparent.png">mongoose</a></div><ul class="pure-menu-list"><li class="pure-menu-horizontal pure-menu-item pure-menu-has-children pure-menu-allow-hover version"><a href="#" class="pure-menu-link">Version 5.1.8-pre</a><ul class="pure-menu-children"><li class="pure-menu-item"><a href="/docs/4.x" class="pure-menu-link">Version 4.13.14</a></li><li class="pure-menu-item"><a href="/docs/3.8.x" class="pure-menu-link">Version 3.8.40</a></li></ul></li><li class="pure-menu-item"><a href="/docs/index.html" class="pure-menu-link">Quick Start</a></li><li class="pure-menu-item"><a href="/docs/guides.html" class="pure-menu-link">Guides</a></li><li class="pure-menu-item sub-item"><a href="/docs/guide.html" class="pure-menu-link">Schemas</a></li><li class="pure-menu-item sub-item"><a href="/docs/schematypes.html" class="pure-menu-link">SchemaTypes</a></li><li class="pure-menu-item sub-item"><a href="/docs/connections.html" class="pure-menu-link">Connections</a></li><li class="pure-menu-item sub-item"><a href="/docs/models.html" class="pure-menu-link">Models</a></li><li class="pure-menu-item sub-item"><a href="/docs/documents.html" class="pure-menu-link">Documents</a></li><li class="pure-menu-item sub-item"><a href="/docs/subdocs.html" class="pure-menu-link">Subdocuments</a></li><li class="pure-menu-item sub-item"><a href="/docs/queries.html" class="pure-menu-link">Queries</a></li><li class="pure-menu-item sub-item"><a href="/docs/validation.html" class="pure-menu-link">Validation</a></li><li class="pure-menu-item sub-item"><a href="/docs/middleware.html" class="pure-menu-link">Middleware</a></li><li class="pure-menu-item sub-item"><a href="/docs/populate.html" class="pure-menu-link">Populate</a></li><li class="pure-menu-item sub-item"><a href="/docs/discriminators.html" class="pure-menu-link">Discriminators</a></li><li class="pure-menu-item sub-item"><a href="/docs/plugins.html" class="pure-menu-link">Plugins</a></li><li class="pure-menu-item"><a href="/docs/api.html" class="pure-menu-link">API</a></li><li class="pure-menu-item sub-item"><a href="/docs/api.html#mongoose_Mongoose" class="pure-menu-link">Mongoose</a></li><li class="pure-menu-item sub-item"><a href="/docs/api.html#Schema" class="pure-menu-link">Schema</a></li><li class="pure-menu-item sub-item"><a href="/docs/api.html#Connection" class="pure-menu-link">Connection</a></li><li class="pure-menu-item sub-item"><a href="/docs/api.html#Document" class="pure-menu-link">Document</a></li><li class="pure-menu-item sub-item"><a href="/docs/api.html#Model" class="pure-menu-link">Model</a></li><li class="pure-menu-item sub-item"><a href="/docs/api.html#Query" class="pure-menu-link">Query</a></li><li class="pure-menu-item sub-item"><a href="/docs/api.html#Aggregate" class="pure-menu-link">Aggregate</a></li><li class="pure-menu-item sub-item"><a href="/docs/api.html#Schematype" class="pure-menu-link">SchemaType</a></li><li class="pure-menu-item sub-item"><a href="/docs/api.html#Virtualtype" class="pure-menu-link">VirtualType</a></li><li class="pure-menu-item"><a href="/docs/compatibility.html" class="pure-menu-link">Version Compatibility</a></li><li class="pure-menu-item"><a href="/docs/faq.html" class="pure-menu-link">FAQ</a></li><li class="carbon-ad"><script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=mongoosejscom" id="_carbonads_js"></script></li></ul></div></div><div class="container"><div id="content"><h2 id="validation"><a href="#validation">Validation

</a></h2>Before we get into the specifics of validation syntax, please keep the following rules in mind:

<ul>

<li>Validation is defined in the <a href="./schematypes.html">SchemaType</a></li>

<li>Validation is <a href="./middleware.html">middleware</a>. Mongoose registers validation as a <code>pre('save')</code> hook on every schema by default.</li>

<li>You can manually run validation using <code>doc.validate(callback)</code> or <code>doc.validateSync()</code></li>

<li>Validators are not run on undefined values. The only exception is the <a href="./api.html#schematype_SchemaType-required"><code>required</code> validator</a>.</li>

<li>Validation is asynchronously recursive; when you call <a href="./api.html#model_Model-save">Model#save</a>, sub-document validation is executed as well. If an error occurs, your <a href="./api.html#model_Model-save">Model#save</a> callback receives it</li>

<li>Validation is customizable</li>

</ul>

<pre><code class="lang-javscript">var schema = new Schema({

type: String,

required: true

}

});

var Cat = db.model('Cat', schema);

// This cat has no name :(

var cat = new Cat();

cat.save(function(error) {

assert.equal(error.errors['name'].message,

'Path `name` is required.');

error = cat.validateSync();

assert.equal(error.errors['name'].message,

'Path `name` is required.');

});

</code></pre>

<h2 id="built-in-validators"><a href="#built-in-validators">Built-in Validators

</a></h2>Mongoose has several built-in validators.

<ul>

<li>All <a href="./schematypes.html">SchemaTypes</a> have the built-in <a href="./api.html#schematype_SchemaType-required">required</a> validator. The required validator uses the <a href="./api.html#schematype_SchemaType-checkRequired">SchemaType's <code>checkRequired()</code> function</a> to determine if the value satisfies the required validator.</li>

<li><a href="./api.html#schema-number-js">Numbers</a> have <a href="./api.html#schema_number_SchemaNumber-min">min</a> and <a href="./api.html#schema_number_SchemaNumber-max">max</a> validators.</li>

<li><a href="./api.html#schema-string-js">Strings</a> have <a href="./api.html#schema_string_SchemaString-enum">enum</a>, <a href="./api.html#schema_string_SchemaString-match">match</a>, <a href="./api.html#schema_string_SchemaString-maxlength">maxlength</a> and <a href="./api.html#schema_string_SchemaString-minlength">minlength</a> validators.</li>

</ul>

Each of the validator links above provide more information about how to enable them and customize their error messages.

<pre><code class="lang-javscript">var breakfastSchema = new Schema({

eggs: {

type: Number,

min: [6, 'Too few eggs'],

max: 12

bacon: {

type: Number,

required: [true, 'Why no bacon?']

drink: {

type: String,

enum: ['Coffee', 'Tea'],

required: function() {

return this.bacon > 3;

}

});

var Breakfast = db.model('Breakfast', breakfastSchema);

var badBreakfast = new Breakfast({

eggs: 2,

bacon: 0,

drink: 'Milk'

});

var error = badBreakfast.validateSync();

assert.equal(error.errors['eggs'].message,

'Too few eggs');

assert.ok(!error.errors['bacon']);

assert.equal(error.errors['drink'].message,

'`Milk` is not a valid enum value for path `drink`.');

badBreakfast.bacon = 5;

badBreakfast.drink = null;

error = badBreakfast.validateSync();

assert.equal(error.errors['drink'].message, 'Path `drink` is required.');

badBreakfast.bacon = null;

error = badBreakfast.validateSync();

assert.equal(error.errors['bacon'].message, 'Why no bacon?');

</code></pre>

<h2 id="the-unique-option-is-not-a-validator"><a href="#the-unique-option-is-not-a-validator">The <code>unique</code> Option is Not a Validator

</a></h2>A common gotcha for beginners is that the <code>unique</code> option for schemas

is not a validator. It's a convenient helper for building <a href="https://docs.mongodb.com/manual/core/index-unique/">MongoDB unique indexes</a>.

See the <a href="/docs/faq.html">FAQ</a> for more information.

<pre><code class="lang-javscript">var uniqueUsernameSchema = new Schema({

username: {

type: String,

unique: true

}

});

var U1 = db.model('U1', uniqueUsernameSchema);

var U2 = db.model('U2', uniqueUsernameSchema);

var dup = [{ username: 'Val' }, { username: 'Val' }];

U1.create(dup, function(error) {

// Race condition! This may save successfully, depending on whether

// MongoDB built the index before writing the 2 docs.

});

// Need to wait for the index to finish building before saving,

// otherwise unique constraints may be violated.

U2.once('index', function(error) {

assert.ifError(error);

U2.create(dup, function(error) {

// Will error, but will *not* be a mongoose validation error, it will be

// a duplicate key error.

assert.ok(error);

assert.ok(!error.errors);

assert.ok(error.message.indexOf('duplicate key error') !== -1);

});

// There's also a promise-based equivalent to the event emitter API.

// The `init()` function is idempotent and returns a promise that

// will resolve once indexes are done building;

U2.init().then(function() {

U2.create(dup, function(error) {

// Will error, but will *not* be a mongoose validation error, it will be

// a duplicate key error.

assert.ok(error);

assert.ok(!error.errors);

assert.ok(error.message.indexOf('duplicate key error') !== -1);

});

</code></pre>

<h2 id="custom-validators"><a href="#custom-validators">Custom Validators

</a></h2>If the built-in validators aren't enough, you can define custom validators

to suit your needs.

Custom validation is declared by passing a validation function.

You can find detailed instructions on how to do this in the

<a href="./api.html#schematype_SchemaType-validate"><code>SchemaType#validate()</code> API docs</a>.

<pre><code class="lang-javscript">var userSchema = new Schema({

phone: {

type: String,

validate: {

validator: function(v) {

return /\d{3}-\d{3}-\d{4}/.test(v);

message: '{VALUE} is not a valid phone number!'

required: [true, 'User phone number required']

}

});

var User = db.model('user', userSchema);

var user = new User();

var error;

user.phone = '555.0123';

error = user.validateSync();

assert.equal(error.errors['phone'].message,

'555.0123 is not a valid phone number!');

user.phone = '';

error = user.validateSync();

assert.equal(error.errors['phone'].message,

'User phone number required');

user.phone = '201-555-0123';

// Validation succeeds! Phone number is defined

// and fits `DDD-DDD-DDDD`

error = user.validateSync();

assert.equal(error, null);

</code></pre>

<h2 id="async-custom-validators"><a href="#async-custom-validators">Async Custom Validators

</a></h2>Custom validators can also be asynchronous. If your validator function

returns a promise (like an <code>async</code> function), mongoose will wait for that

promise to settle. If you prefer callbacks, set the <code>isAsync</code> option,

and mongoose will pass a callback as the 2nd argument to your validator

function.

<pre><code class="lang-javscript">var userSchema = new Schema({

type: String,

// You can also make a validator async by returning a promise. If you

// return a promise, do **not** specify the `isAsync` option.

validate: function(v) {

return new Promise(function(resolve, reject) {

setTimeout(function() {

resolve(false);

}, 5);

});

}

phone: {

type: String,

validate: {

isAsync: true,

validator: function(v, cb) {

setTimeout(function() {

var phoneRegex = /\d{3}-\d{3}-\d{4}/;

var msg = v + ' is not a valid phone number!';

// First argument is a boolean, whether validator succeeded

// 2nd argument is an optional error message override

cb(phoneRegex.test(v), msg);

}, 5);

// Default error message, overridden by 2nd argument to `cb()` above

message: 'Default error message'

required: [true, 'User phone number required']

}

});

var User = db.model('User', userSchema);

var user = new User();

var error;

user.phone = '555.0123';

user.name = 'test';

user.validate(function(error) {

assert.ok(error);

assert.equal(error.errors['phone'].message,

'555.0123 is not a valid phone number!');

assert.equal(error.errors['name'].message,

'Validator failed for path `name` with value `test`');

});

</code></pre>

<h2 id="validation-errors"><a href="#validation-errors">Validation Errors

</a></h2>Errors returned after failed validation contain an <code>errors</code> object

whose values are <code>ValidatorError</code> objects. Each

<a href="./api.html#error-validation-js">ValidatorError</a> has <code>kind</code>, <code>path</code>,

<code>value</code>, and <code>message</code> properties.

A ValidatorError also may have a <code>reason</code> property. If an error was

thrown in the validator, this property will contain the error that was

thrown.

<pre><code class="lang-javscript">var toySchema = new Schema({

color: String,

});

var validator = function(value) {

return /red|white|gold/i.test(value);

};

toySchema.path('color').validate(validator,

'Color `{VALUE}` not valid', 'Invalid color');

toySchema.path('name').validate(function(v) {

if (v !== 'Turbo Man') {

throw new Error('Need to get a Turbo Man for Christmas');

}

return true;

}, 'Name `{VALUE}` is not valid');

var Toy = db.model('Toy', toySchema);

var toy = new Toy({ color: 'Green', name: 'Power Ranger' });

toy.save(function (err) {

// `err` is a ValidationError object

// `err.errors.color` is a ValidatorError object

assert.equal(err.errors.color.message, 'Color `Green` not valid');

assert.equal(err.errors.color.kind, 'Invalid color');

assert.equal(err.errors.color.path, 'color');

assert.equal(err.errors.color.value, 'Green');

// This is new in mongoose 5. If your validator throws an exception,

// mongoose will use that message. If your validator returns `false`,

// mongoose will use the 'Name `Power Ranger` is not valid' message.

assert.equal(err.errors.name.message,

'Need to get a Turbo Man for Christmas');

assert.equal(err.errors.name.value, 'Power Ranger');

// If your validator threw an error, the `reason` property will contain

// the original error thrown, including the original stack trace.

assert.equal(err.errors.name.reason.message,

'Need to get a Turbo Man for Christmas');

assert.equal(err.name, 'ValidationError');

});

</code></pre>

<h2 id="required-validators-on-nested-objects"><a href="#required-validators-on-nested-objects">Required Validators On Nested Objects

</a></h2>Defining validators on nested objects in mongoose is tricky, because

nested objects are not fully fledged paths.

<pre><code class="lang-javscript">var personSchema = new Schema({

first: String,

last: String

}

});

assert.throws(function() {

// This throws an error, because 'name' isn't a full fledged path

personSchema.path('name').required(true);

}, /Cannot.*'required'/);

// To make a nested object required, use a single nested schema

var nameSchema = new Schema({

first: String,

last: String

});

personSchema = new Schema({

type: nameSchema,

required: true

}

});

var Person = db.model('Person', personSchema);

var person = new Person();

var error = person.validateSync();

assert.ok(error.errors['name']);

</code></pre>

<h2 id="update-validators"><a href="#update-validators">Update Validators

</a></h2>In the above examples, you learned about document validation. Mongoose also

supports validation for <code>update()</code> and <code>findOneAndUpdate()</code> operations.

Update validators are off by default - you need to specify

the <code>runValidators</code> option.

To turn on update validators, set the <code>runValidators</code> option for

<code>update()</code> or <code>findOneAndUpdate()</code>. Be careful: update validators

are off by default because they have several caveats.

<pre><code class="lang-javscript">var toySchema = new Schema({

color: String,

});

var Toy = db.model('Toys', toySchema);

Toy.schema.path('color').validate(function (value) {

}, 'Invalid color');

var opts = { runValidators: true };

Toy.update({}, { color: 'bacon' }, opts, function (err) {

assert.equal(err.errors.color.message,

'Invalid color');

});

</code></pre>

<h2 id="update-validators-and-this"><a href="#update-validators-and-this">Update Validators and <code>this</code>

</a></h2>There are a couple of key differences between update validators and

document validators. In the color validation function above, <code>this</code> refers

to the document being validated when using document validation.

However, when running update validators, the document being updated

may not be in the server's memory, so by default the value of <code>this</code> is

not defined.

<pre><code class="lang-javscript">var toySchema = new Schema({

color: String,

});

toySchema.path('color').validate(function(value) {

// When running in `validate()` or `validateSync()`, the

// validator can access the document using `this`.

// Does **not** work with update validators.

if (this.name.toLowerCase().indexOf('red') !== -1) {

return value !== 'red';

}

return true;

});

var Toy = db.model('ActionFigure', toySchema);

var toy = new Toy({ color: 'red', name: 'Red Power Ranger' });

var error = toy.validateSync();

assert.ok(error.errors['color']);

var update = { color: 'red', name: 'Red Power Ranger' };

var opts = { runValidators: true };

Toy.update({}, update, opts, function(error) {

// The update validator throws an error:

// "TypeError: Cannot read property 'toLowerCase' of undefined",

// because `this` is **not** the document being updated when using

// update validators

assert.ok(error);

});

</code></pre>

<h2 id="the-context-option"><a href="#the-context-option">The <code>context</code> option

</a></h2>The <code>context</code> option lets you set the value of <code>this</code> in update validators

to the underlying query.

<pre><code class="lang-javscript">// acquit:ignore:start

var toySchema = new Schema({

color: String,

});

// acquit:ignore:end

toySchema.path('color').validate(function(value) {

// When running update validators with the `context` option set to

// 'query', `this` refers to the query object.

if (this.getUpdate().$set.name.toLowerCase().indexOf('red') !== -1) {

return value === 'red';

}

return true;

});

var Toy = db.model('Figure', toySchema);

var update = { color: 'blue', name: 'Red Power Ranger' };

// Note the context option

var opts = { runValidators: true, context: 'query' };

Toy.update({}, update, opts, function(error) {

assert.ok(error.errors['color']);

});

</code></pre>

<h2 id="update-validators-only-run-on-updated-paths"><a href="#update-validators-only-run-on-updated-paths">Update Validators Only Run On Updated Paths

</a></h2>The other key difference that update validators only run on the paths

specified in the update. For instance, in the below example, because

'name' is not specified in the update operation, update validation will

succeed.

When using update validators, <code>required</code> validators only fail when

you try to explicitly <code>$unset</code> the key.

<pre><code class="lang-javscript">// acquit:ignore:start

var outstanding = 2;

// acquit:ignore:end

var kittenSchema = new Schema({

age: Number

});

var Kitten = db.model('Kitten', kittenSchema);

var update = { color: 'blue' };

var opts = { runValidators: true };

Kitten.update({}, update, opts, function(err) {

// Operation succeeds despite the fact that 'name' is not specified

});

var unset = { $unset: { name: 1 } };

Kitten.update({}, unset, opts, function(err) {

// Operation fails because 'name' is required

assert.ok(err);

assert.ok(err.errors['name']);

});

</code></pre>

<h2 id="update-validators-only-run-for-some-operations"><a href="#update-validators-only-run-for-some-operations">Update Validators Only Run For Some Operations

</a></h2>One final detail worth noting: update validators only run on the

following update operators:

<ul>

<li><code>$unset</code></li>

<li><code>$addToSet</code> (>= 4.8.0)</li>

<li><code>$pullAll</code> (>= 4.12.0)</li>

</ul>

For instance, the below update will succeed, regardless of the value of

<code>number</code>, because update validators ignore <code>$inc</code>.

Also, <code>$push</code>, <code>$addToSet</code>, <code>$pull</code>, and <code>$pullAll</code> validation does

not run any validation on the array itself, only individual elements

of the array.

<pre><code class="lang-javscript">var testSchema = new Schema({

number: { type: Number, max: 0 },

arr: [{ message: { type: String, maxlength: 10 } }]

});

// Update validators won't check this, so you can still `$push` 2 elements

// onto the array, so long as they don't have a `message` that's too long.

testSchema.path('arr').validate(function(v) {

return v.length < 2;

});

var Test = db.model('Test', testSchema);

var update = { $inc: { number: 1 } };

var opts = { runValidators: true };

Test.update({}, update, opts, function(error) {

// There will never be a validation error here

update = { $push: [{ message: 'hello' }, { message: 'world' }] };

Test.update({}, update, opts, function(error) {

// This will never error either even though the array will have at

// least 2 elements.

});

</code></pre>

<h2 id="on-$push-and-$addtoset"><a href="#on-$push-and-$addtoset">On $push and $addToSet

</a></h2>New in 4.8.0: update validators also run on <code>$push</code> and <code>$addToSet</code>

<pre><code class="lang-javscript">var testSchema = new Schema({

numbers: [{ type: Number, max: 0 }],

docs: [{

}]

});

var Test = db.model('TestPush', testSchema);

var update = {

$push: {

numbers: 1,

docs: { name: null }

}

};

var opts = { runValidators: true };

Test.update({}, update, opts, function(error) {

assert.ok(error.errors['numbers']);

assert.ok(error.errors['docs']);

});

</code></pre>

</div></div><script type="text/javascript">!function(name,path,ctx){

var latest,prev=name!=='Keen'&&window.Keen?window.Keen:false;ctx[name]=ctx[name]||{ready:function(fn){var h=document.getElementsByTagName('head')[0],s=document.createElement('script'),w=window,loaded;s.onload=s.onerror=s.onreadystatechange=function(){if((s.readyState&&!(/^c|loade/.test(s.readyState)))||loaded){return}s.onload=s.onreadystatechange=null;loaded=1;latest=w.Keen;if(prev){w.Keen=prev}else{try{delete w.Keen}catch(e){w.Keen=void 0}}ctx[name]=latest;ctx[name].ready(fn)};s.async=1;s.src=path;h.parentNode.insertBefore(s,h)}}

}('KeenAsync','https://d26b395fwzu5fz.cloudfront.net/keen-tracking-1.1.3.min.js',this);

KeenAsync.ready(function(){

// Configure a client instance

var client = new KeenAsync({

projectId: '59aad9cbc9e77c0001ce1b32',

writeKey: '4B38B0046086885E425D368BFAEAD8FD0D4F2DC2FA2F936FDE058D79508AEFAD9886BC020B96520823BB9C8241D9D9BCFDC0EF52E6033BD89D06E4B24FC13AE955896BF443406269A84DD009CEB5862DCEC944874DB2107FD648DA91ADC1E6DE'

});

client.recordEvent('pageView', {

host: window.location.host,

pathname: window.location.pathname,

hash: window.location.hash

});

});</script><script type="text/javascript">(function (window, document) {

var layout = document.getElementById('layout'),

menu = document.getElementById('menu'),

menuLink = document.getElementById('menuLink'),

content = document.getElementById('content');

function toggleClass(element, className) {

var classes = element.className.split(/\s+/),

length = classes.length,

i = 0;

for(; i < length; i++) {

if (classes[i] === className) {

classes.splice(i, 1);

break;

}

// The className is not found

if (length === classes.length) {

classes.push(className);

}

element.className = classes.join(' ');

}

function toggleAll(e) {

var active = 'active';

e.preventDefault();

toggleClass(layout, active);

toggleClass(menu, active);

toggleClass(menuLink, active);

}

menuLink.onclick = function (e) {

toggleAll(e);

};

content.onclick = function(e) {

if (menu.className.indexOf('active') !== -1) {

toggleAll(e);

}

};

}(this, this.document));</script></div></body></html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

validation.html

Latest commit

History

validation.html

File metadata and controls