(DOCSP-14573): set data type

examples/node/Examples/data-types.js

@@ -299,4 +299,92 @@ describe("Node.js Data Types", () => {
     // close the realm
     realm.close();
   });
+  test("should work with the Set data type", async () => {
+    // :code-block-start: define-set-objects
+    const characterSchema = {
+      name: "Character",
+      primaryKey: "_id",
+      properties: {
+        _id: "objectId",
+        name: "string",
+        levelsCompleted: "int<>",
+        inventory: "string<>",
+      },
+    };
+    // :code-block-end:
+    const realm = await Realm.open({
+      schema: [characterSchema],
+    });
+
+    // :code-block-start: create-set-objects
+    let link, hunter;
+    realm.write(() => {
+      link = realm.create("Character", {
+        _id: new BSON.ObjectId(),
+        name: "Link",
+        inventory: ["elixir", "compass", "glowing shield"],
+        levelsCompleted: [4, 9],
+      });
+      hunter = realm.create("Character", {
+        _id: new BSON.ObjectId(),
+        name: "Hunter",
+        inventory: ["estus flask", "gloves", "rune"],
+        levelsCompleted: [1, 2, 5, 24],
+      });
+    });
+    // :code-block-end:
+
+    expect(link.inventory.has("elixir")).toBe(true);
+    expect(hunter.inventory.has("gloves")).toBe(true);
+
+    // :code-block-start: add-items-to-set
+    realm.write(() => {
+      link.inventory.add("hammer");
+      link.levelsCompleted.add(32);
+    });
+    // :code-block-end:
+
+    expect(link.inventory.size).toBe(4);
+    expect(link.levelsCompleted.size).toBe(3);
+
+    // :code-block-start: check-if-set-has-items
+    // check if the hunter has completed level 3 by calling the `set.has()` method
+    const hunterHasCompletedLevelThree = hunter.levelsCompleted.has(3);
+    console.log(
+      `Is level three completed by the hunter: ${hunterHasCompletedLevelThree}`
+    );
+    // :code-block-end:
+    expect(hunterHasCompletedLevelThree).toBe(false);
+
+    // :code-block-start: remove-specific-item-from-set
+    realm.write(() => {
+      // remove the compass from link's inventory by calling `set.delete()` within a write transaction
+      link.inventory.delete("compass");
+    });
+
+    // :code-block-end:
+    expect(link.inventory.has("compass")).toBe(false);
+
+    // :code-block-start: remove-all-items-from-set
+    realm.write(() => {
+      // clear all data from the inventory slot of the hunter by calling `set.clear()` in a write transaction
+      hunter.inventory.clear();
+    });
+    // :code-block-end:
+
+    // :code-block-start: check-set-size
+    // check how many items the hunter has in his inventory through the `set.size` property
+    const hunterInventorySize = hunter.inventory.size;
+    console.log(`The hunter has ${hunterInventorySize} inventory items`);
+    // :code-block-end:
+    expect(hunter.inventory.size).toBe(0);
+
+    // delete the object specifically created in this test to keep tests idempotent
+    realm.write(() => {
+      realm.delete(link);
+      realm.delete(hunter);
+    });
+    // close the realm
+    realm.close();
+  });
 });

source/examples/generated/node/data-types.codeblock.add-items-to-set.js

@@ -0,0 +1,4 @@
+realm.write(() => {
+  link.inventory.add("hammer");
+  link.levelsCompleted.add(32);
+});

source/examples/generated/node/data-types.codeblock.check-if-set-has-items.js

@@ -0,0 +1,5 @@
+// check if the hunter has completed level 3 by calling the `set.has()` method
+const hunterHasCompletedLevelThree = hunter.levelsCompleted.has(3);
+console.log(
+  `Is level three completed by the hunter: ${hunterHasCompletedLevelThree}`
+);

source/examples/generated/node/data-types.codeblock.check-set-size.js

@@ -0,0 +1,3 @@
+// check how many items the hunter has in his inventory through the `set.size` property
+const hunterInventorySize = hunter.inventory.size;
+console.log(`The hunter has ${hunterInventorySize} inventory items`);

source/examples/generated/node/data-types.codeblock.create-set-objects.js

@@ -0,0 +1,15 @@
+let link, hunter;
+realm.write(() => {
+  link = realm.create("Character", {
+    _id: new BSON.ObjectId(),
+    name: "Link",
+    inventory: ["elixir", "compass", "glowing shield"],
+    levelsCompleted: [4, 9],
+  });
+  hunter = realm.create("Character", {
+    _id: new BSON.ObjectId(),
+    name: "Hunter",
+    inventory: ["estus flask", "gloves", "rune"],
+    levelsCompleted: [1, 2, 5, 24],
+  });
+});

source/examples/generated/node/data-types.codeblock.define-set-objects.js

@@ -0,0 +1,10 @@
+const characterSchema = {
+  name: "Character",
+  primaryKey: "_id",
+  properties: {
+    _id: "objectId",
+    name: "string",
+    levelsCompleted: "int<>",
+    inventory: "string<>",
+  },
+};

source/examples/generated/node/data-types.codeblock.remove-all-items-from-set.js

@@ -0,0 +1,4 @@
+realm.write(() => {
+  // clear all data from the inventory slot of the hunter by calling `set.clear()` in a write transaction
+  hunter.inventory.clear();
+});

source/examples/generated/node/data-types.codeblock.remove-specific-item-from-set.js

@@ -0,0 +1,5 @@
+realm.write(() => {
+  // remove the compass from link's inventory by calling `set.delete()` within a write transaction
+  link.inventory.delete("compass");
+});
+

source/sdk/node/data-types/sets.txt

@@ -15,4 +15,88 @@ Sets - Node.js SDK
 .. versionadded:: 10.5.0-beta.1
 
 Overview
---------
+--------
+A {+service-short+} set is a special object that allows you to store a
+collection of unique values. {+service-short+} sets work similarly to JavaScript
+:mdn:`Sets <Web/JavaScript/Reference/Global_Objects/Set>`, except they must be a single
+type and can only be modified within a write-transaction.
+
+.. note:: {+service-short+} Sets Do Not Guarantee Traversal Order
+
+   When using a ``forEach()`` loop or other :mdn:`iteration methods
+   <Web/JavaScript/Reference/Global_Objects/Set#iteration_methods>` to iterate
+   through a loop, {+service-short+} sets may be in a different order than
+   originally written to. If you require an ordered version of your set, you
+   must implement that order yourself. You can do this by creating an array of
+   the set's values in the insertion order.
+
+.. _node-define-set-objects:
+
+Realm Object Models
+-------------------
+To define a property's values as a {+service-short+} set, specify the data type
+followed by a less than and equal sign. For instance, for a set made of integer
+values, specify ``"int<>"``. 
+
+.. literalinclude:: /examples/generated/node/data-types.codeblock.define-set-objects.js
+    :language: javascript
+
+.. _node-create-set-objects:
+
+Create an Object With a Set
+---------------------------
+To create an object with a property that value is of the set data type, create a
+{+service-short+} object within a write transaction. When defining your
+{+service-short+} object, specify your set property's value as an array of
+initial values. 
+
+.. literalinclude:: /examples/generated/node/data-types.codeblock.create-set-objects.js
+    :language: javascript
+
+
+.. _node-add-items-to-set:
+
+Add Items to a Set
+------------------
+To add items to a set, pass the new value to the ``set.add()`` method within a write transaction.
+
+.. literalinclude:: /examples/generated/node/data-types.codeblock.add-items-to-set.js
+    :language: javascript
+
+.. _node-check-if-set-has-items:
+
+Check if a Set has Specific Items
+---------------------------------
+To find out if a set has a particular value, pass the value to the ``set.has()`` method. The
+``set.has()`` method will return true if the set contains the value specified.
+
+.. literalinclude:: /examples/generated/node/data-types.codeblock.check-if-set-has-items.js
+    :language: javascript
+
+.. _node-check-set-size:
+
+Check the Size of a Set
+-----------------------
+To discover how many items are in a set, you can check the set's ``size`` property.
+
+.. literalinclude:: /examples/generated/node/data-types.codeblock.check-set-size.js
+    :language: javascript
+
+.. _node-remove-specific-item-from-set:
+
+Remove an Item from a Set
+-------------------------
+To remove a specific value from a set, pass the value to the ``set.delete()`` method within a write transaction.
+
+.. literalinclude:: /examples/generated/node/data-types.codeblock.remove-specific-item-from-set.js
+    :language: javascript
+
+
+.. _node-remove-all-items-from-set:
+
+Remove all Items from a Set
+---------------------------
+To clear the set, run the ``set.clear()`` method within a write transaction.
+
+.. literalinclude:: /examples/generated/node/data-types.codeblock.remove-all-items-from-set.js
+    :language: javascript