Add examples.

Author: cyrilschumacher

example/array/index.js

@@ -0,0 +1,14 @@
+/**
+ * Example that excludes given JSON keys.
+ */
+
+const fs = require("fs");
+const lib = require("../../lib/jsonPropertyFilter");
+
+const buffer = fs.readFileSync("source.json");
+const source = JSON.parse(buffer.toString());
+
+const filter = new lib.JsonPropertyFilter(["description", "-_private"]);
+const filtered = filter.apply(source);
+
+console.log(filtered); // [ { description: 'First item' }, { description: 'Second item' } ]

example/array/source.json

@@ -0,0 +1,16 @@
+[
+    {
+        "id": 1,
+        "description": "First item",
+        "_private": {
+            "type": "integer"
+        }
+    },
+    {
+        "id": 2,
+        "description": "Second item",
+        "_private": {
+            "type": "string"
+        }
+    }
+]

example/complex/index.js

@@ -0,0 +1,14 @@
+/**
+ * Example that excludes given JSON keys.
+ */
+
+const fs = require("fs");
+const lib = require("../../lib/jsonPropertyFilter");
+
+const buffer = fs.readFileSync("source.json");
+const source = JSON.parse(buffer.toString());
+
+const filter = new lib.JsonPropertyFilter(["**", "-type", "-properties.id.type"]);
+const filtered = filter.apply(source);
+
+console.log(filtered); // { title: 'Product', description: 'A product from Acme\'s catalog', properties: { id: { description: 'The unique identifier for a product' } }, required: [ 'id' ] }

example/complex/source.json

@@ -0,0 +1,12 @@
+{
+    "title": "Product",
+    "description": "A product from Acme's catalog",
+    "type": "object",
+    "properties": {
+        "id": {
+            "description": "The unique identifier for a product",
+            "type": "integer"
+        }
+    },
+    "required": ["id"]
+}

example/include/index.js

@@ -11,4 +11,4 @@ const source = JSON.parse(buffer.toString());
 const filter = new lib.JsonPropertyFilter(["-key2.key3", "-key2.key5"]);
 const filtered = filter.apply(source);
 
-console.log(filtered); // { key1: 'value1', key3: 'value3' }
+console.log(filtered); // { key1: 'value1', key2: { key4: 'value3' } }

example/root/index.js

@@ -11,4 +11,4 @@ const source = JSON.parse(buffer.toString());
 const filter = new lib.JsonPropertyFilter(["*", "key2.*"]);
 const filtered = filter.apply(source);
 
-console.log(filtered); // { key1: 'value1', key3: 'value3' }
+console.log(filtered); // { key1: 'value1', key2: { key3: 'value2', key4: 'value3' } }