Falcor: Global

An atom allows you to treat a JSON value as atomic regardless of its type, ensuring that a JSON object or array is always returned in its entirety. The JSON value must be treated as immutable. Atoms can also be used to associate metadata with a JSON value. This metadata can be used to influence the way values are handled.

Type:

Object

Properties

Source:

typedefs/Atom.js, line 1

Example

// Atom with number value, expiring in 2 seconds
 {
    $type: "atom",
    value: 5
    $expires: -2000
 }
 // Atom with Object value that never expires
 {
    $type: "atom",
    value: {
        foo: 5,
        bar: "baz"
    },
    $expires: 1
 }

An envelope that wraps a JSON object.

Type:

Object

Properties

Source:

typedefs/JSONEnvelope.js, line 1

Example

var model = new falcor.Model();
 model.set({
    json: {
      name: "Steve",
      surname: "McGuire"
    }
 }).then(function(jsonEnvelope) {
    console.log(jsonEnvelope);
 });

JavaScript Object Notation Graph (JSONGraph) is a notation for expressing graphs in JSON. For more information, see the JSONGraph Guide.

Type:

Object

Source:

typedefs/JSONGraph.js, line 1

Example

var $ref = falcor.ref;
 // JSONGraph model modeling a list of film genres, each of which contains the same title.
 {
    // list of user's genres, modeled as a map with ordinal keys
    "genreLists": {
        "0": $ref('genresById[123]'),
        "1": $ref('genresById[522]'),
        "length": 2
    },
    // map of all genres, organized by ID
    "genresById": {
        // genre list modeled as map with ordinal keys
        "123": {
            "name": "Drama",
            "0": $ref('titlesById[23]'),
            "1": $ref('titlesById[99]'),
            "length": 2
        },
        // genre list modeled as map with ordinal keys
        "522": {
            "name": "Comedy",
            "0": $ref('titlesById[23]'),
            "1": $ref('titlesById[44]'),
            "length": 2
        }
    },
    // map of all titles, organized by ID
    "titlesById": {
       "99": {
            "name": "House of Cards",
            "rating": 5
        },
        "23": {
            "name": "Orange is the New Black",
            "rating": 5
        },
        "44": {
            "name": "Arrested Development",
            "rating": 5
        }
    }
}

An envelope that wraps a JSONGraph fragment.

Type:

Object

Properties

Source:

typedefs/JSONGraphEnvelope.js, line 1

Example

var $ref = falcor.ref;
var model = new falcor.Model();
model.set({
  paths: [
    ["todos", [0,1], ["name","done"]]
  ],
  jsonGraph: {
    todos: [
      $ref("todosById[12]"),
      $ref("todosById[15]")
    ],
    todosById: {
      12: {
        name: "go to the ATM",
        done: false
      },
      15: {
        name: "buy milk",
        done: false
      }
    }
  },
}).then(function(jsonEnvelope) {
  console.log(JSON.stringify(jsonEnvelope, null, 4));
});

// prints...
// {
//   json: {
//     todos: {
//       0: {
//         name: "go to the ATM",
//         done: false
//       },
//       1: {
//         name: "buy milk",
//         done: false
//       }
//     }
//   }
// }

A part of a Path that can be any JSON value type. All types are coerced to string, except null. This makes the number 1 and the string "1" equivalent.

Type:

string or number or boolean or null

Source:

typedefs/Key.js, line 1

A part of a PathSet that can be either a Key, Range, or Array of either.

Type:

Key or Range or Array.<(Key|Range)>

Source:

typedefs/KeySet.js, line 1

An ordered list of Keys that point to a value in a JSONGraph.

Type:

Array.<Key>

Source:

typedefs/Path.js, line 1

Example

// Points to the name of product 1234
 ["productsById", "1234", "name"]

An ordered list of KeySets that point to location(s) in the JSONGraph. It enables pointing to multiple locations in a more terse format than a set of Paths and is generally more efficient to evaluate.

Type:

Array.<KeySet>

Source:

typedefs/PathSet.js, line 1

Example

// Points to the name and price of products 1234 and 5678
 ["productsById", ["1234", "5678"], ["name", "price"]]

A wrapper around a path and its value.

Type:

Object

Properties

Source:

typedefs/PathValue.js, line 1

Example

{
	path: ["productsById", "1234", "name"],
	value: "ABC"
 }

Describe a range of integers. Must contain either a "to" or "length" property.

Type:

Object

Properties

Source:

typedefs/Range.js, line 1

Example

// The following range specifies the numbers 0, 1, and 2
 {from: 0, to: 2}
 // The following range specifies the numbers 1 and 2
 {from: 1, length: 2}