SchemaUuid

UUIDv1 SchemaType constructor.

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

Attaches a getter for all UUID instances.

Example:

// Note that `v` is a string by default
mongoose.Schema.UUID.get(v => v.toUpperCase());

const Model = mongoose.model('Test', new Schema({ test: 'UUID' }));
new Model({ test: uuid.v4() }).test; // UUID with all uppercase

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

Example:

// Make Mongoose refuse to cast UUIDs with 0 length
const original = mongoose.Schema.Types.UUID.cast();
mongoose.UUID.cast(v => {
  assert.ok(typeof v === "string" && v.length > 0);
  return original(v);
});

// Or disable casting entirely
mongoose.UUID.cast(false);

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

Check if the given value satisfies a required validator.

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 UUID instances.

Example:

// Make all UUIDs have `required` of true by default.
mongoose.Schema.UUID.set('required', true);

const User = mongoose.model('User', new Schema({ test: mongoose.UUID }));
new User({ }).validateSync().errors.test.message; // Path `test` is required.