1 | # falcor-json-graph
|
2 |
|
3 | A set of factory functions for creating JSON Graph values.
|
4 |
|
5 | ## API
|
6 |
|
7 | ```JavaScript
|
8 | var jsonGraph = require('falcor-json-graph');
|
9 |
|
10 | // { $type: "atom", value: "a string wrapped in an atom" }
|
11 | var atom = jsonGraph.atom("a string wrapped in an atom");
|
12 |
|
13 | // { $type: "atom" }
|
14 | var undefinedAtom = jsonGraph.undefinedAtom();
|
15 |
|
16 | // { $type: "ref", value: ["todos", 0, "name"] }
|
17 | var ref = jsonGraph.ref(["todos", 0, "name"]);
|
18 |
|
19 | // { $type: "error", value: "something bad happened." }
|
20 | var error = jsonGraph.error("something bad happened.");
|
21 |
|
22 | // { path: [ 'user', 'age' ], value: 25 }
|
23 | var pathValue = jsonGraph.pathValue(["user", "age"], 25);
|
24 |
|
25 | // { path: [ 'user', 'age' ], invalidated: true }
|
26 | var pathValue = jsonGraph.pathInvalidation(["user", "age"])
|
27 | ```
|