API for data type UUID

[RealmBot]

Schema

A schema with a UUID property:

const Person = {
  name: “Person”,
  properties: {
    id: “uuid”,
    name: “string”
  }
};

Creating objects with UUID

The BSON library does not have a class for UUID. Currently users of the MongoDB node.js driver are using the uuid-mongodb package. Using the 3rd party package, creating an object will look like:

const MUUID = require('uuid-mongodb');
realm.write(() => {
  realm.create(“Person”, { id: MUUID.v4(), name: “John Doe” });
});

When a proper UUID class is added to the BSON library, we imagine that we should use the following instead:

const UUID = require('bson').UUID;
realm.write(() => {
  realm.create(“Person”, { id: new UUID(), name: “John Doe” });
});

The above API for creating a new object will be consistent with the API for both ObjectId and Decimal128 (also from the BSON library).

[sync-by-unito]

➤ Steffen Agger commented:

Local mock implemented, awaiting UUID in bson-package.