Protean ======= > An ever changing set of utilities. Summary ------- Installation ------------ ~~~ % npm install protean ~~~ API --- ## Modules
Protean
Falcor
## Classes
CollectionSource ⇐ ProteanClass
CompositeSource ⇐ ProteanClass
JSONGraphEnvelopeProxy ⇐ ProteanClass
NoCacheSource ⇐ ProteanClass
PartitionedSource ⇐ ProteanClass
ProxiedSource ⇐ ProteanClass
StorageSource ⇐ ProteanClass
ProteanClass : function
Storage ⇐ ProteanClass
Store ⇐ ProteanClass
Collection ⇐ ProteanClass
FiniteStateMachine ⇐ Subject
LinkedList ⇐ ProteanClass
Record ⇐ ProteanClass
## Typedefs
onNextFunction : function
onErrorFunction : function
onCompletedFunction : function
Observable
Observer
Disposable
Subject ⇐ Observable
DataSource
Sentinel : Object
Reference : Sentinel
RootReference : Reference
Atom : Sentinel
JSONEnvelope : Object
JSONGraph : Object
JSONGraphEnvelope : Object
Key : String | null
KeySet : Key | Range | Array.<(Key|Range)>
Path : Array.<Key>
PathSet : Array.<KeySet>
PathValue : Object
Range : Object
## Protean * [Protean](#module_Protean) * [.Rx](#module_Protean.Rx) * [.append](#module_Protean.Rx.append) ⇒ Observable.<String> * [.mv](#module_Protean.Rx.mv) ⇒ Observable.<String> * [.fsWrapper](#module_Protean.Rx.fsWrapper) ⇒ function * [.write](#module_Protean.Rx.write) ⇒ Observable.<String> * [.from(arg)](#module_Protean.Rx.from) ⇒ [Observable](#Observable) * [.cp(from, to, [opts])](#module_Protean.Rx.cp) ⇒ Observable.<fs.Stats> * [.glob(pattern, [opts])](#module_Protean.Rx.glob) ⇒ Observable.<String> * [.isDirectory(paths)](#module_Protean.Rx.isDirectory) ⇒ Observable.<Boolean> * [.isFile(paths)](#module_Protean.Rx.isFile) ⇒ Observable.<Boolean> * [.mkdir(paths, [opts])](#module_Protean.Rx.mkdir) ⇒ Observable.<String> * [.read(patterns, [enc])](#module_Protean.Rx.read) ⇒ Observable.<(String\|Buffer)> * [.rm(patterns, [recursive])](#module_Protean.Rx.rm) ⇒ Observable.<String> * [.stat(patterns)](#module_Protean.Rx.stat) ⇒ Observable.<external:fs.Stats> * [.link(patterns)](#module_Protean.Rx.stat.link) ⇒ Observable.<external:fs.Stats> * [.fd(fds)](#module_Protean.Rx.stat.fd) ⇒ Observable.<external:fs.Stats> * [.denominate](#module_Protean.denominate) ⇒ Object * [.invoke](#module_Protean.invoke) ⇒ \* * [.pluck](#module_Protean.pluck) ⇒ \* | function * [.classnames(arg)](#module_Protean.classnames) ⇒ String * [.classify([subclass], props, [properties])](#module_Protean.classify) ⇒ [ProteanClass](#ProteanClass) * [.inherit(superclass, [subclass], [props], [properties])](#module_Protean.inherit) ⇒ [ProteanClass](#ProteanClass) * [.instantiate(fn, [args])](#module_Protean.instantiate) ⇒ Object * [.augment(...obj)](#module_Protean.augment) ⇒ Object * [.enmap(...args)](#module_Protean.enmap) ⇒ Object * [.enumerate()](#module_Protean.enumerate) ⇒ Object * [.traverse(obj, visitor, [post])](#module_Protean.traverse) * _static_ * [.SKIP](#module_Protean.traverse.SKIP) : String * [.CONTINUE](#module_Protean.traverse.CONTINUE) : String * [.BREAK](#module_Protean.traverse.BREAK) : String * _inner_ * [~visitorFn(path, value, context)](#module_Protean.traverse..visitorFn) ⇒ undefined | String * [.guid()](#module_Protean.guid) ⇒ String * [.mergeExports(receiver, supplier)](#module_Protean.mergeExports) ⇒ Object ### Protean.Rx **Kind**: static property of [Protean](#module_Protean) * [.Rx](#module_Protean.Rx) * [.append](#module_Protean.Rx.append) ⇒ Observable.<String> * [.mv](#module_Protean.Rx.mv) ⇒ Observable.<String> * [.fsWrapper](#module_Protean.Rx.fsWrapper) ⇒ function * [.write](#module_Protean.Rx.write) ⇒ Observable.<String> * [.from(arg)](#module_Protean.Rx.from) ⇒ [Observable](#Observable) * [.cp(from, to, [opts])](#module_Protean.Rx.cp) ⇒ Observable.<fs.Stats> * [.glob(pattern, [opts])](#module_Protean.Rx.glob) ⇒ Observable.<String> * [.isDirectory(paths)](#module_Protean.Rx.isDirectory) ⇒ Observable.<Boolean> * [.isFile(paths)](#module_Protean.Rx.isFile) ⇒ Observable.<Boolean> * [.mkdir(paths, [opts])](#module_Protean.Rx.mkdir) ⇒ Observable.<String> * [.read(patterns, [enc])](#module_Protean.Rx.read) ⇒ Observable.<(String\|Buffer)> * [.rm(patterns, [recursive])](#module_Protean.Rx.rm) ⇒ Observable.<String> * [.stat(patterns)](#module_Protean.Rx.stat) ⇒ Observable.<external:fs.Stats> * [.link(patterns)](#module_Protean.Rx.stat.link) ⇒ Observable.<external:fs.Stats> * [.fd(fds)](#module_Protean.Rx.stat.fd) ⇒ Observable.<external:fs.Stats> #### Rx.append ⇒ Observable.<String> **Kind**: static property of [Rx](#module_Protean.Rx) | Param | Type | | --- | --- | | filepath | String | | data | Buffer | String | | [opts] | Object | String | #### Rx.mv ⇒ Observable.<String> **File:** [rx/fs/mv.js](rx/fs/mv.js) **Kind**: static property of [Rx](#module_Protean.Rx) | Param | Type | Default | | --- | --- | --- | | from | String | | | to | String | | | opts | Object | | | [opts.mkdirp] | Boolean | false | | [opts.clobber] | Boolean | false | #### Rx.fsWrapper ⇒ function **Kind**: static property of [Rx](#module_Protean.Rx) | Param | Type | | --- | --- | | method | String | #### Rx.write ⇒ Observable.<String> **Kind**: static property of [Rx](#module_Protean.Rx) | Param | Type | | --- | --- | | filepath | String | | data | Buffer | String | | [opts] | Object | String | #### Rx.from(arg) ⇒ [Observable](#Observable) **File:** [rx/from.js](rx/from.js) **Kind**: static method of [Rx](#module_Protean.Rx) | Param | Type | | --- | --- | | arg | [Observable](#Observable) | Promise | Array | Object | #### Rx.cp(from, to, [opts]) ⇒ Observable.<fs.Stats> **File:** [rx/fs/cp.js](rx/fs/cp.js) **Kind**: static method of [Rx](#module_Protean.Rx) | Param | Type | Default | | --- | --- | --- | | from | String | Array.<String> | Observable.<String> | Promise.<String> | | | to | String | | | [opts] | Object | | | [opts.recursive] | Boolean | true | | [opts.force] | Boolean | false | #### Rx.glob(pattern, [opts]) ⇒ Observable.<String> **File:** [rx/glob.js](rx/glob.js) **Kind**: static method of [Rx](#module_Protean.Rx) **Returns**: Observable.<String> - An Observable emiting the paths found | Param | Type | Description | | --- | --- | --- | | pattern | String | The glob pattern | | [opts] | Object | [https://github.com/isaacs/node-glob#options](https://github.com/isaacs/node-glob#options) | #### Rx.isDirectory(paths) ⇒ Observable.<Boolean> **File:** [rx/is-directory.js](rx/is-directory.js) **Kind**: static method of [Rx](#module_Protean.Rx) **Returns**: Observable.<Boolean> - An Observable emiting the paths found | Param | Type | | --- | --- | | paths | String | Array.<String> | Observable.<String> | #### Rx.isFile(paths) ⇒ Observable.<Boolean> **File:** [rx/is-file.js](rx/is-file.js) **Kind**: static method of [Rx](#module_Protean.Rx) | Param | Type | | --- | --- | | paths | String | Array.<String> | Observable.<String> | #### Rx.mkdir(paths, [opts]) ⇒ Observable.<String> Create the given paths in the file system. **File:** [rx/mkdir.js](rx/mkdir.js) **Kind**: static method of [Rx](#module_Protean.Rx) | Param | Type | Default | | --- | --- | --- | | paths | String | Array.<String> | Observable.<String> | | | [opts] | Object | | | [opts.mode] | String | '0777' | #### Rx.read(patterns, [enc]) ⇒ Observable.<(String\|Buffer)> **File:** [rx/read.js](rx/read.js) **Kind**: static method of [Rx](#module_Protean.Rx) | Param | Type | | --- | --- | | patterns | String | Array.<String> | Observable.<String> | Promise.<String> | | [enc] | String | #### Rx.rm(patterns, [recursive]) ⇒ Observable.<String> **File:** [rx/rm.js](rx/rm.js) **Kind**: static method of [Rx](#module_Protean.Rx) | Param | Type | Default | | --- | --- | --- | | patterns | String | Array.<String> | Observable.<String> | Promise.<String> | | | [recursive] | Boolean | true | #### Rx.stat(patterns) ⇒ Observable.<external:fs.Stats> **File:** [rx/stat.js](rx/stat.js) **Kind**: static method of [Rx](#module_Protean.Rx) **Returns**: Observable.<external:fs.Stats> - An Observable emiting the paths found | Param | Type | | --- | --- | | patterns | String | Array.<String> | Observable.<String> | Promise.<String> | * [.stat(patterns)](#module_Protean.Rx.stat) ⇒ Observable.<external:fs.Stats> * [.link(patterns)](#module_Protean.Rx.stat.link) ⇒ Observable.<external:fs.Stats> * [.fd(fds)](#module_Protean.Rx.stat.fd) ⇒ Observable.<external:fs.Stats> ##### stat.link(patterns) ⇒ Observable.<external:fs.Stats> **Kind**: static method of [stat](#module_Protean.Rx.stat) | Param | Type | | --- | --- | | patterns | String | Array.<String> | Observable.<String> | Promise.<String> | ##### stat.fd(fds) ⇒ Observable.<external:fs.Stats> **Kind**: static method of [stat](#module_Protean.Rx.stat) | Param | Type | | --- | --- | | fds | Integer | Array.<Integer> | Observable.<Integer> | Promise.<Integer> | ### Protean.denominate ⇒ Object **Kind**: static property of [Protean](#module_Protean) **Returns**: Object - The object now with a immutable 'name' property of the given name value | Param | Type | | --- | --- | | obj | Object | | name | String | ### Protean.invoke ⇒ \* **Kind**: static property of [Protean](#module_Protean) | Param | Type | | --- | --- | | property | String | | subject | Object | ### Protean.pluck ⇒ \* | function **File:** [object/pluck.js](object/pluck.js) **Kind**: static property of [Protean](#module_Protean) | Param | Type | | --- | --- | | key | String | | [obj] | Object | ### Protean.classnames(arg) ⇒ String Utility function to get a className string. Supply a list of strings, or objects with class names -> boolean indicating whether that class should be used. The returned string will contain all the class names indicated without duplicates, and separated by spaces. **File**: [dom/classnames.js](dom/classnames.js) **Kind**: static method of [Protean](#module_Protean) | Param | Type | | --- | --- | | arg | String | Object.<String, Boolean> | ### Protean.classify([subclass], props, [properties]) ⇒ [ProteanClass](#ProteanClass) Create a constructor function passing in it's prototype methods. **File**: [function/classify](function/classify.js) **Kind**: static method of [Protean](#module_Protean) | Param | Type | Description | | --- | --- | --- | | [subclass] | function | The subclass constructor function. | | props | Object | Bare properties for the constructor's prototype. | | [properties] | Object | Object.defineProperty property definitions. | ### Protean.inherit(superclass, [subclass], [props], [properties]) ⇒ [ProteanClass](#ProteanClass) Create a constructor function that inherits properties and methods from the given super constructor. **File**: [function/inherit.js](function/inherit.js) **Kind**: static method of [Protean](#module_Protean) **Returns**: [ProteanClass](#ProteanClass) - The constructor function. | Param | Type | Default | Description | | --- | --- | --- | --- | | superclass | function | | The function to inherit from. | | [subclass] | function | Function | The Subclass constructor function. If omitted, and a `constructor` property is not defined in `props`, defaults to a function that calls the superclass' constructor function. | | [props] | Object | | Bare properties to initialize the prototype with. | | [properties] | Object | {} | Object.defineProperty property definitions. | ### Protean.instantiate(fn, [args]) ⇒ Object Create a new object and then apply the constructor function with the arguments. **File**: [function/instantiate.js](function/instantiate.js) **Kind**: static method of [Protean](#module_Protean) **Returns**: Object - The new instance | Param | Type | Description | | --- | --- | --- | | fn | function | The constructor function | | [args] | Array.<Mixed> | Arguments to pass to the constructor function | ### Protean.augment(...obj) ⇒ Object Like 'extend', but it preserves getters and setters, and will not overwrite existing properties defined directly on the source object. **File:** [object/augment.js](object/augment.js) **Kind**: static method of [Protean](#module_Protean) | Param | Type | | --- | --- | | ...obj | Object | ### Protean.enmap(...args) ⇒ Object Takes a list of alternating key/values and returns an object. **File:** [object/enmap.js](object/enmap.js) **Kind**: static method of [Protean](#module_Protean) | Param | Type | | --- | --- | | ...args | Mixed | ### Protean.enumerate() ⇒ Object Takes an argument list of strings and returns an object with those keys, and their values being the index of that key plus one. **File:** [object/enumerate.js](object/enumerate.js) **Kind**: static method of [Protean](#module_Protean) | Type | | --- | | String | ### Protean.traverse(obj, visitor, [post]) **Kind**: static method of [Protean](#module_Protean) | Param | Type | Default | Description | | --- | --- | --- | --- | | obj | Object | | | | visitor | [visitorFn](#module_Protean.traverse..visitorFn) | | | | [post] | Boolean | false | Do a post traversal | * [.traverse(obj, visitor, [post])](#module_Protean.traverse) * _static_ * [.SKIP](#module_Protean.traverse.SKIP) : String * [.CONTINUE](#module_Protean.traverse.CONTINUE) : String * [.BREAK](#module_Protean.traverse.BREAK) : String * _inner_ * [~visitorFn(path, value, context)](#module_Protean.traverse..visitorFn) ⇒ undefined | String #### traverse.SKIP : String **Kind**: static constant of [traverse](#module_Protean.traverse) #### traverse.CONTINUE : String **Kind**: static constant of [traverse](#module_Protean.traverse) #### traverse.BREAK : String **Kind**: static constant of [traverse](#module_Protean.traverse) #### traverse~visitorFn(path, value, context) ⇒ undefined | String **File:** [object/traverse.js](object/traverse.js) **Kind**: inner method of [traverse](#module_Protean.traverse) **Returns**: undefined | String - One of the constants of 'skip', 'continue', or 'break'. Returning undefined is the same as returing 'continue'. | Param | Type | Description | | --- | --- | --- | | path | Array.<String> | The path to the value | | value | Mixed | The value | | context | Object | The original object | ### Protean.guid() ⇒ String Fast GUID generator, RFC4122 version 4 compliant. **File:** [utility/guid.js](utility/guid.js) **Kind**: static method of [Protean](#module_Protean) **See**: http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/21963136#21963136 **Author:** Jeff Ward (jcward.com). **License**: MIT license ### Protean.mergeExports(receiver, supplier) ⇒ Object **File:** [utility/merge-exports.js](utility/merge-exports.js) **Kind**: static method of [Protean](#module_Protean) | Param | Type | | --- | --- | | receiver | Object | | supplier | function | Object | ## Falcor * [Falcor](#module_Falcor) * [.Graph](#module_Falcor.Graph) * [.set](#module_Falcor.Graph.set) ⇒ Object * [.atoms(graph, fn)](#module_Falcor.Graph.atoms) * [~visitorFn(path, atom, graph)](#module_Falcor.Graph.atoms..visitorFn) * [.fromObject(obj, [opts])](#module_Falcor.Graph.fromObject) ⇒ [JSONGraph](#JSONGraph) * [.isAtom(sentinel)](#module_Falcor.Graph.isAtom) ⇒ Boolean * [.isError(sentinel)](#module_Falcor.Graph.isError) ⇒ Boolean * [.isRef(sentinel)](#module_Falcor.Graph.isRef) ⇒ Boolean * [.isRootRef(sentinel)](#module_Falcor.Graph.isRootRef) ⇒ Boolean * [.isSentinel(sentinel)](#module_Falcor.Graph.isSentinel) ⇒ Boolean * [.refs(graph, fn)](#module_Falcor.Graph.refs) * [~visitorFn(path, ref, graph)](#module_Falcor.Graph.refs..visitorFn) * [.relative(root, graph)](#module_Falcor.Graph.relative) ⇒ [JSONGraph](#JSONGraph) * [.resolve(root, graph)](#module_Falcor.Graph.resolve) ⇒ [JSONGraph](#JSONGraph) * [.rootRef(path, value, props)](#module_Falcor.Graph.rootRef) ⇒ [Reference](#Reference) * [.sentinels(graph, fn)](#module_Falcor.Graph.sentinels) * [~visitorFn(path, sentinel, graph)](#module_Falcor.Graph.sentinels..visitorFn) * [.toObject(graph, [opts])](#module_Falcor.Graph.toObject) ⇒ [JSONGraph](#JSONGraph) * [.Path](#module_Falcor.Path) * [.relative(root, paths)](#module_Falcor.Path.relative) ⇒ [Array.<PathSet>](#PathSet) * [.resolve(root, paths)](#module_Falcor.Path.resolve) ⇒ [Array.<PathSet>](#PathSet) ### Falcor.Graph **File:** [falcor/graph.js](falcor/graph.js) **Kind**: static property of [Falcor](#module_Falcor) **See**: [https://github.com/Netflix/falcor-json-graph](https://github.com/Netflix/falcor-json-graph) * [.Graph](#module_Falcor.Graph) * [.set](#module_Falcor.Graph.set) ⇒ Object * [.atoms(graph, fn)](#module_Falcor.Graph.atoms) * [~visitorFn(path, atom, graph)](#module_Falcor.Graph.atoms..visitorFn) * [.fromObject(obj, [opts])](#module_Falcor.Graph.fromObject) ⇒ [JSONGraph](#JSONGraph) * [.isAtom(sentinel)](#module_Falcor.Graph.isAtom) ⇒ Boolean * [.isError(sentinel)](#module_Falcor.Graph.isError) ⇒ Boolean * [.isRef(sentinel)](#module_Falcor.Graph.isRef) ⇒ Boolean * [.isRootRef(sentinel)](#module_Falcor.Graph.isRootRef) ⇒ Boolean * [.isSentinel(sentinel)](#module_Falcor.Graph.isSentinel) ⇒ Boolean * [.refs(graph, fn)](#module_Falcor.Graph.refs) * [~visitorFn(path, ref, graph)](#module_Falcor.Graph.refs..visitorFn) * [.relative(root, graph)](#module_Falcor.Graph.relative) ⇒ [JSONGraph](#JSONGraph) * [.resolve(root, graph)](#module_Falcor.Graph.resolve) ⇒ [JSONGraph](#JSONGraph) * [.rootRef(path, value, props)](#module_Falcor.Graph.rootRef) ⇒ [Reference](#Reference) * [.sentinels(graph, fn)](#module_Falcor.Graph.sentinels) * [~visitorFn(path, sentinel, graph)](#module_Falcor.Graph.sentinels..visitorFn) * [.toObject(graph, [opts])](#module_Falcor.Graph.toObject) ⇒ [JSONGraph](#JSONGraph) #### Graph.set ⇒ Object **File:** [falcor/graph/set.js](falcor/graph/set.js) **Kind**: static property of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | source | Object | | path | String | Array.<String> | | value | \* | #### Graph.atoms(graph, fn) **File:** [falcor/graph/atoms.js](falcor/graph/atoms.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | graph | [JSONGraph](#JSONGraph) | | fn | Graph.atoms~visitorFn | ##### atoms~visitorFn(path, atom, graph) **Kind**: inner method of [atoms](#module_Falcor.Graph.atoms) | Param | Type | | --- | --- | | path | [Path](#Path) | | atom | [Atom](#Atom) | | graph | [JSONGraph](#JSONGraph) | #### Graph.fromObject(obj, [opts]) ⇒ [JSONGraph](#JSONGraph) Takes a normal javascript object and returns a JSONGraph. **File:** [falcor/graph/from-object.js](falcor/graph/from-object.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | Default | | --- | --- | --- | | obj | Object | | | [opts] | Object | | | [opts.arrayIsRef] | Boolean | true | | [opts.root] | [Path](#Path) | [] | #### Graph.isAtom(sentinel) ⇒ Boolean **File:** [falcor/graph/is-atom.js](falcor/graph/is-atom.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | sentinel | \* | #### Graph.isError(sentinel) ⇒ Boolean **File:** [falcor/graph/is-error.js](falcor/graph/is-error.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | sentinel | \* | #### Graph.isRef(sentinel) ⇒ Boolean **File:** [falcor/graph/is-ref.js](falcor/graph/is-ref.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | sentinel | \* | #### Graph.isRootRef(sentinel) ⇒ Boolean **File:** [falcor/graph/is-root-ref.js](falcor/graph/is-root-ref.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | sentinel | \* | #### Graph.isSentinel(sentinel) ⇒ Boolean **File:** [falcor/graph/is-sentinel.js](falcor/graph/is-sentinel.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | sentinel | \* | #### Graph.refs(graph, fn) **File:** [falcor/graph/refs.js](falcor/graph/refs.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | graph | [JSONGraph](#JSONGraph) | | fn | Graph.atoms~visitorFn | ##### refs~visitorFn(path, ref, graph) **Kind**: inner method of [refs](#module_Falcor.Graph.refs) | Param | Type | | --- | --- | | path | [Path](#Path) | | ref | [Reference](#Reference) | | graph | [JSONGraph](#JSONGraph) | #### Graph.relative(root, graph) ⇒ [JSONGraph](#JSONGraph) **File:** [falcor/graph/relative.js](falcor/graph/relative.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | root | [Path](#Path) | | graph | [JSONGraph](#JSONGraph) | #### Graph.resolve(root, graph) ⇒ [JSONGraph](#JSONGraph) **File:** [falcor/graph/resolve.js](falcor/graph/resolve.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | root | [Path](#Path) | | graph | [JSONGraph](#JSONGraph) | #### Graph.rootRef(path, value, props) ⇒ [Reference](#Reference) **File:** [falcor/graph/root-ref.js](falcor/graph/root-ref.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | path | [Path](#Path) | | value | [Path](#Path) | | props | Object | #### Graph.sentinels(graph, fn) **File:** [falcor/graph/sentinels.js](falcor/graph/sentinels.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | graph | [JSONGraph](#JSONGraph) | | fn | Graph.sentinels~visitorFn | ##### sentinels~visitorFn(path, sentinel, graph) **Kind**: inner method of [sentinels](#module_Falcor.Graph.sentinels) | Param | Type | | --- | --- | | path | [Path](#Path) | | sentinel | [Sentinel](#Sentinel) | | graph | [JSONGraph](#JSONGraph) | #### Graph.toObject(graph, [opts]) ⇒ [JSONGraph](#JSONGraph) Takes a JSONGraph and returns a Javascript Object. **File:** [falcor/graph/to-object.js](falcor/graph/to-object.js) **Kind**: static method of [Graph](#module_Falcor.Graph) | Param | Type | | --- | --- | | graph | [JSONGraph](#JSONGraph) | | [opts] | Object | ### Falcor.Path **Kind**: static property of [Falcor](#module_Falcor) **See**: [https://github.com/Netflix/falcor-path-utils](https://github.com/Netflix/falcor-path-utils) * [.Path](#module_Falcor.Path) * [.relative(root, paths)](#module_Falcor.Path.relative) ⇒ [Array.<PathSet>](#PathSet) * [.resolve(root, paths)](#module_Falcor.Path.resolve) ⇒ [Array.<PathSet>](#PathSet) #### Path.relative(root, paths) ⇒ [Array.<PathSet>](#PathSet) **File:** [falcor/path/relative.js](falcor/path/relative.js) **Kind**: static method of [Path](#module_Falcor.Path) | Param | Type | | --- | --- | | root | [Path](#Path) | | paths | [Array.<PathSet>](#PathSet) | #### Path.resolve(root, paths) ⇒ [Array.<PathSet>](#PathSet) **File:** [falcor/path/resolve.js](falcor/path/resolve.js) **Kind**: static method of [Path](#module_Falcor.Path) | Param | Type | | --- | --- | | root | [Path](#Path) | | paths | [Array.<PathSet>](#PathSet) | ## CollectionSource ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) **Implements:** [DataSource](#DataSource) * [CollectionSource](#CollectionSource) ⇐ [ProteanClass](#ProteanClass) * [new CollectionSource([collection], [opts])](#new_CollectionSource_new) * [.options](#CollectionSource+options) * [.indexedPath](#CollectionSource+options.indexedPath) * [.keyedPath](#CollectionSource+options.keyedPath) * [.lengthPath](#CollectionSource+options.lengthPath) * [.addPath](#CollectionSource+options.addPath) * [.removePath](#CollectionSource+options.removePath) * [.router](#CollectionSource+router) * [.routes](#CollectionSource+routes) * [.get(paths)](#CollectionSource+get) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.set(envelope)](#CollectionSource+set) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.call(path, args, refSuffixes, thisPaths)](#CollectionSource+call) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.getLength()](#CollectionSource+getLength) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.getRecordByIndex(paths)](#CollectionSource+getRecordByIndex) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.getRecordProps(paths)](#CollectionSource+getRecordProps) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.setRecordProps(graph)](#CollectionSource+setRecordProps) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.addRecord(path, args, refSuffixes, thisPaths)](#CollectionSource+addRecord) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.removeRecord(path, args, refSuffixes, thisPaths)](#CollectionSource+removeRecord) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) ### new CollectionSource([collection], [opts]) **file:** [falcor/data-source/collection.js](falcor/data-source/collection.js) | Param | Type | Default | | --- | --- | --- | | [collection] | [Collection](#Collection) | | | [opts] | Object | | | [opts.indexedPath] | [Path](#Path) | ['byIndex'] | | [opts.keyedPath] | [Path](#Path) | ['byId'] | ### collectionSource.options Default options **Kind**: instance property of [CollectionSource](#CollectionSource) **Properties** | Type | | --- | | Object | * [.options](#CollectionSource+options) * [.indexedPath](#CollectionSource+options.indexedPath) * [.keyedPath](#CollectionSource+options.keyedPath) * [.lengthPath](#CollectionSource+options.lengthPath) * [.addPath](#CollectionSource+options.addPath) * [.removePath](#CollectionSource+options.removePath) #### options.indexedPath **Kind**: static property of [options](#CollectionSource+options) **Properties** | Type | | --- | | [Path](#Path) | #### options.keyedPath **Kind**: static property of [options](#CollectionSource+options) **Properties** | Type | | --- | | [Path](#Path) | #### options.lengthPath **Kind**: static property of [options](#CollectionSource+options) **Properties** | Type | | --- | | [Path](#Path) | #### options.addPath **Kind**: static property of [options](#CollectionSource+options) **Properties** | Type | | --- | | [Path](#Path) | #### options.removePath **Kind**: static property of [options](#CollectionSource+options) **Properties** | Type | | --- | | [Path](#Path) | ### collectionSource.router **Kind**: instance property of [CollectionSource](#CollectionSource) **See**: [http://netflix.github.io/falcor/documentation/router.html](http://netflix.github.io/falcor/documentation/router.html) **Properties** | Type | | --- | | external:FalcorRouter | ### collectionSource.routes **Kind**: instance property of [CollectionSource](#CollectionSource) **Properties** | Type | | --- | | Array.<Object> | ### collectionSource.get(paths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CollectionSource](#CollectionSource) **Implements:** [get](#DataSource+get) | Param | Type | | --- | --- | | paths | [Array.<PathSet>](#PathSet) | ### collectionSource.set(envelope) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CollectionSource](#CollectionSource) **Implements:** [set](#DataSource+set) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### collectionSource.call(path, args, refSuffixes, thisPaths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CollectionSource](#CollectionSource) **Implements:** [call](#DataSource+call) | Param | Type | | --- | --- | | path | [PathSet](#PathSet) | | args | Array.<Mixed> | | refSuffixes | [Array.<PathSet>](#PathSet) | | thisPaths | [Array.<PathSet>](#PathSet) | ### collectionSource.getLength() ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CollectionSource](#CollectionSource) ### collectionSource.getRecordByIndex(paths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CollectionSource](#CollectionSource) | Param | Type | | --- | --- | | paths | Array.<PathSets> | ### collectionSource.getRecordProps(paths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CollectionSource](#CollectionSource) | Param | Type | | --- | --- | | paths | Array.<PathSets> | ### collectionSource.setRecordProps(graph) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CollectionSource](#CollectionSource) | Param | Type | | --- | --- | | graph | [JSONGraph](#JSONGraph) | ### collectionSource.addRecord(path, args, refSuffixes, thisPaths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CollectionSource](#CollectionSource) | Param | Type | | --- | --- | | path | [PathSet](#PathSet) | | args | Array.<Mixed> | | refSuffixes | [Array.<PathSet>](#PathSet) | | thisPaths | [Array.<PathSet>](#PathSet) | ### collectionSource.removeRecord(path, args, refSuffixes, thisPaths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CollectionSource](#CollectionSource) | Param | Type | | --- | --- | | path | [PathSet](#PathSet) | | args | Array.<Mixed> | | refSuffixes | [Array.<PathSet>](#PathSet) | | thisPaths | [Array.<PathSet>](#PathSet) | ## CompositeSource ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) **Implements:** [DataSource](#DataSource) * [CompositeSource](#CompositeSource) ⇐ [ProteanClass](#ProteanClass) * [new CompositeSource(...args)](#new_CompositeSource_new) * [.sources](#CompositeSource+sources) * [.get(paths)](#CompositeSource+get) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.set(envelope)](#CompositeSource+set) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.call(path, args, refSuffixes, thisPaths)](#CompositeSource+call) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.add(path, source)](#CompositeSource+add) ⇒ [CompositeSource](#CompositeSource) ### new CompositeSource(...args) A [DataSource] that allows for composing several different [DataSource]s together through different [Path]s. This allows individual [DataSource]s to be constructed, used, and tested in their own domain. Then later you can compose them into a larger [Graph]. The CompositeSource manages the re-writing of [Path]s and the resulting [Graph] so it appears that everything comes from a larger [Graph]. Basically, all returned [Path]s/[Graph]s are updated to have any references relative to their [Path]s in the CompositeSource. As a result, there was a need to create a new [Falcor] data type to express when a sub [DataSource] wanted to reference another part of the larger [Graph]. [RootReference](#RootReference) represents a [Reference] in the [Graph] that should not be kept local to the underlying [DataSource], but should be interpreted from the root of the CompositeSource. **File:** [falcor/data-source/composite.js](falcor/data-source/composite.js) [Falcor]: http://netflix.github.io/falcor/doc/DataSource.html "Falcor" [DataSource]: http://netflix.github.io/falcor/doc/DataSource.html "DataSource" [Path]: http://netflix.github.io/falcor/doc/global.html#Path "Path" [Graph]: http://netflix.github.io/falcor/documentation/jsongraph.html "Graph" [Reference]: http://netflix.github.io/falcor/documentation/jsongraph.html#reference "Reference" | Param | Type | | --- | --- | | ...args | Array.<Path, DataSource> | ### compositeSource.sources **Kind**: instance property of [CompositeSource](#CompositeSource) **Properties** | Type | | --- | | Object.<Path, ProxiedSource> | ### compositeSource.get(paths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CompositeSource](#CompositeSource) **Implements:** [get](#DataSource+get) | Param | Type | | --- | --- | | paths | Array.<PathSets> | ### compositeSource.set(envelope) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CompositeSource](#CompositeSource) **Implements:** [set](#DataSource+set) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### compositeSource.call(path, args, refSuffixes, thisPaths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [CompositeSource](#CompositeSource) **Implements:** [call](#DataSource+call) | Param | Type | | --- | --- | | path | [Path](#Path) | | args | Array.<Mixed> | | refSuffixes | [Array.<PathSet>](#PathSet) | | thisPaths | [Array.<PathSet>](#PathSet) | ### compositeSource.add(path, source) ⇒ [CompositeSource](#CompositeSource) **Kind**: instance method of [CompositeSource](#CompositeSource) **Returns**: [CompositeSource](#CompositeSource) - the CompositeSource instance | Param | Type | | --- | --- | | path | [Path](#Path) | | source | [DataSource](#DataSource) | ## JSONGraphEnvelopeProxy ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) **Implements:** JSONGraphEnevelope * [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) ⇐ [ProteanClass](#ProteanClass) * [new JSONGraphEnvelopeProxy([opts])](#new_JSONGraphEnvelopeProxy_new) * [.paths](#JSONGraphEnvelopeProxy+paths) * [.jsonGraph](#JSONGraphEnvelopeProxy+jsonGraph) * [.invalidated](#JSONGraphEnvelopeProxy+invalidated) * [.expecting](#JSONGraphEnvelopeProxy+expecting) * [.pending](#JSONGraphEnvelopeProxy+pending) * [.set(pathOrGraph, [atom])](#JSONGraphEnvelopeProxy+set) * [.invalidate(...path)](#JSONGraphEnvelopeProxy+invalidate) * [.fulfill(path)](#JSONGraphEnvelopeProxy+fulfill) * [.expect(paths)](#JSONGraphEnvelopeProxy+expect) * [.relativeFrom(from)](#JSONGraphEnvelopeProxy+relativeFrom) ⇒ [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) * [.resolvedFrom(from)](#JSONGraphEnvelopeProxy+resolvedFrom) ⇒ [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) * [.merge(other)](#JSONGraphEnvelopeProxy+merge) * [.destroy()](#JSONGraphEnvelopeProxy+destroy) * [.clone()](#JSONGraphEnvelopeProxy+clone) ⇒ [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) * [.valueOf()](#JSONGraphEnvelopeProxy+valueOf) ⇒ [JSONGraphEnvelope](#JSONGraphEnvelope) * [.finalize()](#JSONGraphEnvelopeProxy+finalize) ⇒ [JSONGraphEnvelope](#JSONGraphEnvelope) ### new JSONGraphEnvelopeProxy([opts]) | Param | Type | Description | | --- | --- | --- | | [opts] | Object | | | [opts.expect] | [Array.<PathSet>](#PathSet) | Paths to expect | | [opts.paths] | [Array.<PathSet>](#PathSet) | A starting set of paths | | [opts.jsonGraph] | [JSONGraph](#JSONGraph) | A starting JSONGraph | | [opts.invalidated] | [Array.<PathSet>](#PathSet) | A starting set of paths to invalidate | ### jsonGraphEnvelopeProxy.paths **Kind**: instance property of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) **Properties** | Type | | --- | | [Array.<PathSet>](#PathSet) | ### jsonGraphEnvelopeProxy.jsonGraph **Kind**: instance property of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) **Properties** | Type | | --- | | [JSONGraph](#JSONGraph) | ### jsonGraphEnvelopeProxy.invalidated **Kind**: instance property of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) **Properties** | Type | | --- | | [Array.<PathSet>](#PathSet) | ### jsonGraphEnvelopeProxy.expecting **Kind**: instance property of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) **Properties** | Type | | --- | | Object | ### jsonGraphEnvelopeProxy.pending Get a list of paths this envelope is still expecting to fulfill **Kind**: instance property of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) **Read only**: true **Properties** | Type | | --- | | [Array.<Path>](#Path) | ### jsonGraphEnvelopeProxy.set(pathOrGraph, [atom]) **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) | Param | Type | | --- | --- | | pathOrGraph | [Path](#Path) | [JSONGraph](#JSONGraph) | | [atom] | [Atom](#Atom) | ### jsonGraphEnvelopeProxy.invalidate(...path) **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) | Param | Type | | --- | --- | | ...path | [Path](#Path) | ### jsonGraphEnvelopeProxy.fulfill(path) Mark a path as fulfilled and set the given value on our jsonGraph **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) | Param | Type | | --- | --- | | path | [Path](#Path) | ### jsonGraphEnvelopeProxy.expect(paths) Prepare this envelope to expect to fulfill a certain set of paths. **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) | Param | Type | | --- | --- | | paths | [Array.<PathSet>](#PathSet) | ### jsonGraphEnvelopeProxy.relativeFrom(from) ⇒ [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) **Returns**: [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) - A copy | Param | Type | | --- | --- | | from | [Path](#Path) | ### jsonGraphEnvelopeProxy.resolvedFrom(from) ⇒ [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) **Returns**: [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) - A copy | Param | Type | | --- | --- | | from | [Path](#Path) | ### jsonGraphEnvelopeProxy.merge(other) Merge another JSONGraphEnvelope into this one **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) | Param | Type | | --- | --- | | other | [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### jsonGraphEnvelopeProxy.destroy() Clear out our data so we do not have any dangling memory. **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) ### jsonGraphEnvelopeProxy.clone() ⇒ [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) Get a copy of this proxy **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) ### jsonGraphEnvelopeProxy.valueOf() ⇒ [JSONGraphEnvelope](#JSONGraphEnvelope) **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) ### jsonGraphEnvelopeProxy.finalize() ⇒ [JSONGraphEnvelope](#JSONGraphEnvelope) **Kind**: instance method of [JSONGraphEnvelopeProxy](#JSONGraphEnvelopeProxy) ## NoCacheSource ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) **Implements:** [DataSource](#DataSource) * [NoCacheSource](#NoCacheSource) ⇐ [ProteanClass](#ProteanClass) * [new NoCacheSource(opts)](#new_NoCacheSource_new) * [.get(paths)](#NoCacheSource+get) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.set(envelope)](#NoCacheSource+set) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.call(path, args, refSuffixes, thisPaths)](#NoCacheSource+call) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) ### new NoCacheSource(opts) A Falcor DataSource that proxies another data source and sets all returned atoms to expire immediately. **file:** [falcor/data-source/no-cache.js](falcor/data-source/no-cache.js) | Param | Type | | --- | --- | | opts | Object | | opts.source | [DataSource](#DataSource) | ### noCacheSource.get(paths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [NoCacheSource](#NoCacheSource) **Implements:** [get](#DataSource+get) | Param | Type | | --- | --- | | paths | Array.<PathSets> | ### noCacheSource.set(envelope) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [NoCacheSource](#NoCacheSource) **Implements:** [set](#DataSource+set) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### noCacheSource.call(path, args, refSuffixes, thisPaths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [NoCacheSource](#NoCacheSource) **Implements:** [call](#DataSource+call) | Param | Type | | --- | --- | | path | [PathSet](#PathSet) | | args | Array.<Mixed> | | refSuffixes | [Array.<PathSet>](#PathSet) | | thisPaths | [Array.<PathSet>](#PathSet) | ## PartitionedSource ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) **Implements:** [DataSource](#DataSource) * [PartitionedSource](#PartitionedSource) ⇐ [ProteanClass](#ProteanClass) * [new PartitionedSource([opts])](#new_PartitionedSource_new) * [.options](#PartitionedSource+options) * [.reads](#PartitionedSource+options.reads) * [.writes](#PartitionedSource+options.writes) * [.partitions](#PartitionedSource+options.partitions) * [.get(paths)](#PartitionedSource+get) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.set(envelope)](#PartitionedSource+set) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.call(path, args, refSuffixes, thisPaths)](#PartitionedSource+call) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) ### new PartitionedSource([opts]) A falcor DataSource that optionally reads from and writes to a variety of 'partitions' of other DataSources. When reading (get) it will try the partitions in the order set by the 'reads' option. Any paths gone unfilled by the first, will be requested by the second, and so on. The final graph is a merge of all returned values from those partitions. When writing (set/call) it will send the request to all given partitions in the 'writes' option. Again, returning a merged graph of all values writen. | Param | Type | Default | | --- | --- | --- | | [opts] | Object | | | [opts.reads] | Array.<String> | [] | | [opts.writes] | Array.<String> | [] | | [opts.partitions] | Object.<String, DataSource> | {} | ### partitionedSource.options Default options **Kind**: instance property of [PartitionedSource](#PartitionedSource) **Properties** | Type | | --- | | Object | * [.options](#PartitionedSource+options) * [.reads](#PartitionedSource+options.reads) * [.writes](#PartitionedSource+options.writes) * [.partitions](#PartitionedSource+options.partitions) #### options.reads **Kind**: static property of [options](#PartitionedSource+options) **Properties** | Type | | --- | | Array.<String> | #### options.writes **Kind**: static property of [options](#PartitionedSource+options) **Properties** | Type | | --- | | Array.<String> | #### options.partitions **Kind**: static property of [options](#PartitionedSource+options) **Properties** | Type | | --- | | Object.<String, DataSource> | ### partitionedSource.get(paths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [PartitionedSource](#PartitionedSource) **Implements:** [get](#DataSource+get) | Param | Type | | --- | --- | | paths | [Array.<PathSet>](#PathSet) | ### partitionedSource.set(envelope) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [PartitionedSource](#PartitionedSource) **Implements:** [set](#DataSource+set) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### partitionedSource.call(path, args, refSuffixes, thisPaths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [PartitionedSource](#PartitionedSource) **Implements:** [call](#DataSource+call) | Param | Type | | --- | --- | | path | [PathSet](#PathSet) | | args | Array.<Mixed> | | refSuffixes | [Array.<PathSet>](#PathSet) | | thisPaths | [Array.<PathSet>](#PathSet) | ## ProxiedSource ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) **Implements:** [DataSource](#DataSource) * [ProxiedSource](#ProxiedSource) ⇐ [ProteanClass](#ProteanClass) * [new ProxiedSource([opts])](#new_ProxiedSource_new) * [.source](#ProxiedSource+source) * [.root](#ProxiedSource+root) * [.get(paths)](#ProxiedSource+get) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.set(envelope)](#ProxiedSource+set) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.call(path, args, refSuffixes, thisPaths)](#ProxiedSource+call) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.willGet(paths)](#ProxiedSource+willGet) ⇒ Boolean * [.willSet(envelope)](#ProxiedSource+willSet) ⇒ Boolean * [.willCall(path)](#ProxiedSource+willCall) ⇒ Boolean * [.getRelativeEnvelope(envelope)](#ProxiedSource+getRelativeEnvelope) ⇒ [JSONGraphEnvelope](#JSONGraphEnvelope) * [.getResolvedEnvelope(envelope)](#ProxiedSource+getResolvedEnvelope) ⇒ [JSONGraphEnvelope](#JSONGraphEnvelope) ### new ProxiedSource([opts]) A Falcor DataSource that proxies to another source, re-writing the returned paths, and the paths to the values within the JSONGraph. **File:** [falcor/data-source/proxied.js](falcor/data-source/proxied.js) | Param | Type | | --- | --- | | [opts] | Object | | [opts.source] | [DataSource](#DataSource) | | [opts.root] | [Path](#Path) | ### proxiedSource.source **Kind**: instance property of [ProxiedSource](#ProxiedSource) **Properties** | Type | | --- | | [DataSource](#DataSource) | ### proxiedSource.root **Kind**: instance property of [ProxiedSource](#ProxiedSource) **Properties** | Type | | --- | | [Path](#Path) | ### proxiedSource.get(paths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [ProxiedSource](#ProxiedSource) **Implements:** [get](#DataSource+get) | Param | Type | | --- | --- | | paths | Array.<PathSets> | ### proxiedSource.set(envelope) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [ProxiedSource](#ProxiedSource) **Implements:** [set](#DataSource+set) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### proxiedSource.call(path, args, refSuffixes, thisPaths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [ProxiedSource](#ProxiedSource) **Implements:** [call](#DataSource+call) | Param | Type | | --- | --- | | path | [PathSet](#PathSet) | | args | Array.<Mixed> | | refSuffixes | [Array.<PathSet>](#PathSet) | | thisPaths | [Array.<PathSet>](#PathSet) | ### proxiedSource.willGet(paths) ⇒ Boolean Will the given paths be consumed by a get request against this datasource? **Kind**: instance method of [ProxiedSource](#ProxiedSource) | Param | Type | | --- | --- | | paths | [Array.<PathSet>](#PathSet) | ### proxiedSource.willSet(envelope) ⇒ Boolean Will the given JSONGraphEnvelope be consumed by a set request against this datasource? **Kind**: instance method of [ProxiedSource](#ProxiedSource) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### proxiedSource.willCall(path) ⇒ Boolean Will the given path be consumed by a call request against this datasource? **Kind**: instance method of [ProxiedSource](#ProxiedSource) | Param | Type | | --- | --- | | path | [Path](#Path) | ### proxiedSource.getRelativeEnvelope(envelope) ⇒ [JSONGraphEnvelope](#JSONGraphEnvelope) Strip our leading path from the envelope's path(s) and jsonGraph object. **Kind**: instance method of [ProxiedSource](#ProxiedSource) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### proxiedSource.getResolvedEnvelope(envelope) ⇒ [JSONGraphEnvelope](#JSONGraphEnvelope) Adjust the JSONGraphEnvelope to reflect our leading path information. **Kind**: instance method of [ProxiedSource](#ProxiedSource) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ## StorageSource ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) **Implements:** [DataSource](#DataSource) * [StorageSource](#StorageSource) ⇐ [ProteanClass](#ProteanClass) * [new StorageSource(opts)](#new_StorageSource_new) * [.model](#StorageSource+model) * [.source](#StorageSource+source) * [.options](#StorageSource+options) * [.storageKey](#StorageSource+options.storageKey) * [.storage](#StorageSource+options.storage) * [.serializer(graph)](#StorageSource+options.serializer) ⇒ String * [.deserializer(src)](#StorageSource+options.deserializer) ⇒ [JSONGraph](#JSONGraph) * [.get(paths)](#StorageSource+get) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.set(envelope)](#StorageSource+set) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.call(path, args, refSuffixes, thisPaths)](#StorageSource+call) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.clear()](#StorageSource+clear) * [.serialize()](#StorageSource+serialize) * [.deserialize()](#StorageSource+deserialize) ### new StorageSource(opts) **File:** [falcor/data-source/storage.js](falcor/data-source/storage.js) | Param | Type | | --- | --- | | opts | Object | | opts.storage | [Storage](#Storage) | | opts.storageKey | String | | [opts.cache] | Object | | [opts.serializer] | function | | [opts.deserializer] | function | ### storageSource.model **Kind**: instance property of [StorageSource](#StorageSource) **Properties** | Type | | --- | | FalcorFModel | ### storageSource.source **Kind**: instance property of [StorageSource](#StorageSource) **Properties** | Type | | --- | | [DataSource](#DataSource) | ### storageSource.options **Kind**: instance property of [StorageSource](#StorageSource) **Properties** | Type | | --- | | Object | * [.options](#StorageSource+options) * [.storageKey](#StorageSource+options.storageKey) * [.storage](#StorageSource+options.storage) * [.serializer(graph)](#StorageSource+options.serializer) ⇒ String * [.deserializer(src)](#StorageSource+options.deserializer) ⇒ [JSONGraph](#JSONGraph) #### options.storageKey The key to use when accessing the Storage object to serialize the graph to. **Kind**: static property of [options](#StorageSource+options) **Properties** | Type | | --- | | String | #### options.storage The storage source **Kind**: static property of [options](#StorageSource+options) **Properties** | Type | | --- | | [Storage](#Storage) | #### options.serializer(graph) ⇒ String A function to convert a JSONGraph to a String. **Kind**: static method of [options](#StorageSource+options) | Param | Type | | --- | --- | | graph | [JSONGraph](#JSONGraph) | #### options.deserializer(src) ⇒ [JSONGraph](#JSONGraph) A function to convert a String to a JSONGraph. **Kind**: static method of [options](#StorageSource+options) | Param | Type | | --- | --- | | src | String | ### storageSource.get(paths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [StorageSource](#StorageSource) **Implements:** [get](#DataSource+get) | Param | Type | | --- | --- | | paths | Array.<PathSets> | ### storageSource.set(envelope) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [StorageSource](#StorageSource) **Implements:** [set](#DataSource+set) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### storageSource.call(path, args, refSuffixes, thisPaths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [StorageSource](#StorageSource) **Implements:** [call](#DataSource+call) | Param | Type | | --- | --- | | path | [PathSet](#PathSet) | | args | Array.<Mixed> | | refSuffixes | [Array.<PathSet>](#PathSet) | | thisPaths | [Array.<PathSet>](#PathSet) | ### storageSource.clear() Clear our storage item **Kind**: instance method of [StorageSource](#StorageSource) ### storageSource.serialize() Write our cache to storage **Kind**: instance method of [StorageSource](#StorageSource) ### storageSource.deserialize() Get our cache from storage **Kind**: instance method of [StorageSource](#StorageSource) ## ProteanClass : function **Kind**: global class * [ProteanClass](#ProteanClass) : function * [.superproto](#ProteanClass.superproto) : Object * [.extend([subclass], [props], [properties])](#ProteanClass.extend) ⇒ [ProteanClass](#ProteanClass) * [.extended(subclass)](#ProteanClass.extended) * [.superclass()](#ProteanClass.superclass) ### ProteanClass.superproto : Object A reference to this class' superclass prototype **Kind**: static property of [ProteanClass](#ProteanClass) ### ProteanClass.extend([subclass], [props], [properties]) ⇒ [ProteanClass](#ProteanClass) A function to extend this class into another one **Kind**: static method of [ProteanClass](#ProteanClass) | Param | Type | | --- | --- | | [subclass] | function | | [props] | Object | | [properties] | Object | ### ProteanClass.extended(subclass) A function that will be called when the class is extended into another **Kind**: static method of [ProteanClass](#ProteanClass) | Param | Type | | --- | --- | | subclass | function | ### ProteanClass.superclass() A reference to this class' superclass constructor **Kind**: static method of [ProteanClass](#ProteanClass) ## Storage ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) **Implements:** external:Storage * [Storage](#Storage) ⇐ [ProteanClass](#ProteanClass) * [new Storage(opts)](#new_Storage_new) * [.length](#Storage+length) * [.getItem(key)](#Storage+getItem) ⇒ Mixed * [.getJSON(key)](#Storage+getJSON) ⇒ null | Object * [.setItem(key, value)](#Storage+setItem) * [.setJSON(key, value)](#Storage+setJSON) * [.removeItem(key)](#Storage+removeItem) * [.clear()](#Storage+clear) * [.key(idx)](#Storage+key) ⇒ String ### new Storage(opts) **File:** [storage/index.js](storage/index.js) | Param | Type | | --- | --- | | opts | Object | | opts.store | external:Storage | | opts.json | JSON | ### storage.length **Kind**: instance property of [Storage](#Storage) **Read only**: true **Properties** | Type | | --- | | Integer | ### storage.getItem(key) ⇒ Mixed **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | key | String | ### storage.getJSON(key) ⇒ null | Object **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | key | String | ### storage.setItem(key, value) **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | key | String | | value | String | ### storage.setJSON(key, value) **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | key | String | | value | String | ### storage.removeItem(key) **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | key | String | ### storage.clear() **Kind**: instance method of [Storage](#Storage) ### storage.key(idx) ⇒ String **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | idx | Integer | ## Store ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) **Implements:** external:Storage * [Store](#Store) ⇐ [ProteanClass](#ProteanClass) * [new Store()](#new_Store_new) * _instance_ * [.length](#Store+length) * [.getItem(key)](#Store+getItem) ⇒ null | String * [.setItem(key, value)](#Store+setItem) * [.removeItem(key)](#Store+removeItem) * [.clear()](#Store+clear) * [.key(idx)](#Store+key) ⇒ String * _static_ * [.local](#Store.local) : external:Storage * [.memory](#Store.memory) : module:Protean.Store * [.session](#Store.session) : external:Storage ### new Store() **File:** [storage/store/index.js](storage/store/index.js) ### store.length **Kind**: instance property of [Store](#Store) **Read only**: true **Properties** | Type | | --- | | Integer | ### store.getItem(key) ⇒ null | String **Kind**: instance method of [Store](#Store) | Param | Type | | --- | --- | | key | String | ### store.setItem(key, value) **Kind**: instance method of [Store](#Store) | Param | Type | | --- | --- | | key | String | | value | String | ### store.removeItem(key) **Kind**: instance method of [Store](#Store) | Param | Type | | --- | --- | | key | String | ### store.clear() **Kind**: instance method of [Store](#Store) ### store.key(idx) ⇒ String **Kind**: instance method of [Store](#Store) | Param | Type | | --- | --- | | idx | Integer | ### Store.local : external:Storage **File:** [storage/store/local.js](storage/store/local.js) **Kind**: static property of [Store](#Store) ### Store.memory : module:Protean.Store **File:** [storage/store/memory.js](storage/store/memory.js) **Kind**: static property of [Store](#Store) ### Store.session : external:Storage **File:** [storage/store/session.js](storage/store/session.js) **Kind**: static property of [Store](#Store) ## Collection ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) * [Collection](#Collection) ⇐ [ProteanClass](#ProteanClass) * [new Collection([rec])](#new_Collection_new) * [.idKey](#Collection+idKey) * [.comparator](#Collection+comparator) * [.length](#Collection+length) * [.records](#Collection+records) * [.has(id)](#Collection+has) ⇒ Boolean * [.add(obj)](#Collection+add) ⇒ [Record](#Record) * [.remove(id)](#Collection+remove) ⇒ [Record](#Record) * [.at(idx)](#Collection+at) ⇒ [Record](#Record) * [.removeAt(idx)](#Collection+removeAt) ⇒ [Record](#Record) * [.get(id)](#Collection+get) ⇒ [Record](#Record) * [.indexOf(idOrRecord)](#Collection+indexOf) ⇒ Integer * [.clear()](#Collection+clear) ⇒ [Collection](#Collection) * [.valueOf()](#Collection+valueOf) ⇒ Array.<Object> * [.find(predicate)](#Collection+find) ⇒ [Record](#Record) * [.sort([comparator])](#Collection+sort) ⇒ [Collection](#Collection) * [.map(iteratee)](#Collection+map) ⇒ [Collection](#Collection) * [.each(iteratee)](#Collection+each) * [.where(predicate)](#Collection+where) ⇒ [Collection](#Collection) * [.by(comparator)](#Collection+by) ⇒ [Collection](#Collection) * [.clone()](#Collection+clone) ⇒ [Collection](#Collection) * [.cloneDeep()](#Collection+cloneDeep) ⇒ [Collection](#Collection) ### new Collection([rec]) **File:** [utility/collection.js](utility/collection.js) | Param | Type | | --- | --- | | [rec] | [Record](#Record) | Object | ### collection.idKey The unique identifier key to use for records **Kind**: instance property of [Collection](#Collection) **Default**: 'id' **Properties** | Type | | --- | | String | ### collection.comparator Used to keep the collection ordered when adding items **Kind**: instance property of [Collection](#Collection) **Properties** | Type | | --- | | function | ### collection.length **Kind**: instance property of [Collection](#Collection) **Read only**: true **Properties** | Type | | --- | | Integer | ### collection.records **Kind**: instance property of [Collection](#Collection) **Read only**: true **Properties** | Type | | --- | | [Array.<Record>](#Record) | ### collection.has(id) ⇒ Boolean **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | id | String | ### collection.add(obj) ⇒ [Record](#Record) **Kind**: instance method of [Collection](#Collection) **Returns**: [Record](#Record) - The record just created | Param | Type | | --- | --- | | obj | Object | [Record](#Record) | ### collection.remove(id) ⇒ [Record](#Record) **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | id | String | ### collection.at(idx) ⇒ [Record](#Record) **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | idx | Integer | ### collection.removeAt(idx) ⇒ [Record](#Record) **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | idx | Integer | ### collection.get(id) ⇒ [Record](#Record) **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | id | String | ### collection.indexOf(idOrRecord) ⇒ Integer **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | idOrRecord | String | [Record](#Record) | ### collection.clear() ⇒ [Collection](#Collection) **Kind**: instance method of [Collection](#Collection) ### collection.valueOf() ⇒ Array.<Object> **Kind**: instance method of [Collection](#Collection) ### collection.find(predicate) ⇒ [Record](#Record) **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | predicate | function | ### collection.sort([comparator]) ⇒ [Collection](#Collection) Mutates the collection to sorted based on the given comparator, or the one defined on itself. **Kind**: instance method of [Collection](#Collection) | Param | Type | Default | | --- | --- | --- | | [comparator] | function | this.comparator | ### collection.map(iteratee) ⇒ [Collection](#Collection) **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | iteratee | function | ### collection.each(iteratee) **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | iteratee | function | ### collection.where(predicate) ⇒ [Collection](#Collection) **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | predicate | function | ### collection.by(comparator) ⇒ [Collection](#Collection) **Kind**: instance method of [Collection](#Collection) | Param | Type | | --- | --- | | comparator | function | ### collection.clone() ⇒ [Collection](#Collection) Returns a copy of the collection with all the records (the records are not cloned) **Kind**: instance method of [Collection](#Collection) ### collection.cloneDeep() ⇒ [Collection](#Collection) Returns a Collection with all records cloned. **Kind**: instance method of [Collection](#Collection) ## FiniteStateMachine ⇐ [Subject](#Subject) **Kind**: global class **Extends:** [Subject](#Subject), [ProteanClass](#ProteanClass) * [FiniteStateMachine](#FiniteStateMachine) ⇐ [Subject](#Subject) * [new FiniteStateMachine([opts])](#new_FiniteStateMachine_new) * [.options](#FiniteStateMachine+options) * [.initial](#FiniteStateMachine+options.initial) * [.current](#FiniteStateMachine+options.current) * [.stateless](#FiniteStateMachine+options.stateless) * [.states](#FiniteStateMachine+options.states) * [.transitions](#FiniteStateMachine+transitions) * [.currentState](#FiniteStateMachine+currentState) * [.currentInputs](#FiniteStateMachine+currentInputs) * [.add(name, transitions)](#FiniteStateMachine+add) ⇒ [FiniteStateMachine](#FiniteStateMachine) * [.remove(name)](#FiniteStateMachine+remove) ⇒ [FiniteStateMachine](#FiniteStateMachine) * [.has(name)](#FiniteStateMachine+has) ⇒ Boolean * [.can(input)](#FiniteStateMachine+can) ⇒ Boolean * [.will(input)](#FiniteStateMachine+will) ⇒ String | false * [.onNext(input)](#FiniteStateMachine+onNext) ⇒ Boolean * [.onError(error)](#FiniteStateMachine+onError) * [.onCompleted()](#FiniteStateMachine+onCompleted) * [.dispose()](#FiniteStateMachine+dispose) * [.input(input)](#FiniteStateMachine+input) ⇒ Boolean * [.enter(name)](#FiniteStateMachine+enter) ⇒ Boolean * [.transition(input, from, to)](#FiniteStateMachine+transition) ⇒ [FiniteStateMachine](#FiniteStateMachine) * [.valueOf()](#FiniteStateMachine+valueOf) ⇒ Object ### new FiniteStateMachine([opts]) **File:** [utility/fsm.js](utility/fsm.js) **Throws**: - Error "ProteanFiniteStateMachine needs an initial state" If no initial state is given and `stateless` is false. | Param | Type | Default | Description | | --- | --- | --- | --- | | [opts] | Object | | | | [opts.initial] | String | | The initial state to begin in | | [opts.current] | String | | Alias for initial | | [opts.states] | Object.<String, Object> | {} | A map of state names to objects that have inputs as keys, and resulting state names as values. | | [opts.stateless] | Boolean | false | Allow the machine to be in a stateless state. Default false. | ### finiteStateMachine.options Default options **Kind**: instance property of [FiniteStateMachine](#FiniteStateMachine) **Properties** | Type | | --- | | Object | * [.options](#FiniteStateMachine+options) * [.initial](#FiniteStateMachine+options.initial) * [.current](#FiniteStateMachine+options.current) * [.stateless](#FiniteStateMachine+options.stateless) * [.states](#FiniteStateMachine+options.states) #### options.initial **Kind**: static property of [options](#FiniteStateMachine+options) **Properties** | Type | | --- | | String | #### options.current **Kind**: static property of [options](#FiniteStateMachine+options) **Properties** | Type | | --- | | String | #### options.stateless **Kind**: static property of [options](#FiniteStateMachine+options) **Properties** | Type | | --- | | Boolean | #### options.states **Kind**: static property of [options](#FiniteStateMachine+options) **Properties** | Type | | --- | | Object.<String, Object> | ### finiteStateMachine.transitions **Kind**: instance property of [FiniteStateMachine](#FiniteStateMachine) **Properties** | Type | | --- | | [Subject](#Subject) | ### finiteStateMachine.currentState The current state **Kind**: instance property of [FiniteStateMachine](#FiniteStateMachine) **Properties** | Type | | --- | | String | ### finiteStateMachine.currentInputs Get the currently available inputs **Kind**: instance property of [FiniteStateMachine](#FiniteStateMachine) **Read only**: true **Properties** | Type | | --- | | Array.<String> | ### finiteStateMachine.add(name, transitions) ⇒ [FiniteStateMachine](#FiniteStateMachine) Add a state and its available transitions **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) | Param | Type | | --- | --- | | name | String | | transitions | Object.<String, String> | ### finiteStateMachine.remove(name) ⇒ [FiniteStateMachine](#FiniteStateMachine) Remove a state and its transitions **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) | Param | Type | | --- | --- | | name | String | ### finiteStateMachine.has(name) ⇒ Boolean **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) | Param | Type | | --- | --- | | name | String | ### finiteStateMachine.can(input) ⇒ Boolean **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) | Param | Type | | --- | --- | | input | String | ### finiteStateMachine.will(input) ⇒ String | false **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) **Returns**: String | false - the name of the resulting state, or false | Param | Type | | --- | --- | | input | String | ### finiteStateMachine.onNext(input) ⇒ Boolean **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) | Param | Type | | --- | --- | | input | String | ### finiteStateMachine.onError(error) **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) | Param | Type | | --- | --- | | error | Error | ### finiteStateMachine.onCompleted() **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) ### finiteStateMachine.dispose() **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) ### finiteStateMachine.input(input) ⇒ Boolean **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) | Param | Type | | --- | --- | | input | String | ### finiteStateMachine.enter(name) ⇒ Boolean **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) | Param | Type | | --- | --- | | name | String | ### finiteStateMachine.transition(input, from, to) ⇒ [FiniteStateMachine](#FiniteStateMachine) **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) | Param | Type | | --- | --- | | input | String | | from | String | | to | String | ### finiteStateMachine.valueOf() ⇒ Object **Kind**: instance method of [FiniteStateMachine](#FiniteStateMachine) ## LinkedList ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) * [LinkedList](#LinkedList) ⇐ [ProteanClass](#ProteanClass) * [new LinkedList([...items])](#new_LinkedList_new) * _instance_ * [.head](#LinkedList+head) * [.tail](#LinkedList+tail) * [.push(...value)](#LinkedList+push) ⇒ Integer * [.pop()](#LinkedList+pop) ⇒ \* * [.unshift(...value)](#LinkedList+unshift) ⇒ Integer * [.shift()](#LinkedList+shift) ⇒ \* * [.nodeAt(idx)](#LinkedList+nodeAt) ⇒ LinkdList.Node * [.at(idx)](#LinkedList+at) ⇒ \* * [.insert(nodeOrValue, siblingOrIndex)](#LinkedList+insert) * [.remove(nodeOrIndex)](#LinkedList+remove) * [.reset()](#LinkedList+reset) * [.forEach(fn, [scope])](#LinkedList+forEach) * [.map(fn, [scope])](#LinkedList+map) ⇒ [LinkedList](#LinkedList) * [.filter(fn, [scope])](#LinkedList+filter) ⇒ [LinkedList](#LinkedList) * [.reduce(fn, [value], [scope])](#LinkedList+reduce) ⇒ \* * [.toArray()](#LinkedList+toArray) ⇒ Array.<\*> * _static_ * [.Node](#LinkedList.Node) ⇐ Object * [new Node(data, [prev], [next])](#new_LinkedList.Node_new) * [.next](#LinkedList.Node+next) * [.prev](#LinkedList.Node+prev) * [.data](#LinkedList.Node+data) * [.insert(prev, next)](#LinkedList.Node+insert) * [.remove()](#LinkedList.Node+remove) ### new LinkedList([...items]) | Param | Type | | --- | --- | | [...items] | \* | ### linkedList.head **Kind**: instance property of [LinkedList](#LinkedList) **Properties** | Type | | --- | | [Node](#LinkedList.Node) | ### linkedList.tail **Kind**: instance property of [LinkedList](#LinkedList) **Properties** | Type | | --- | | [Node](#LinkedList.Node) | ### linkedList.push(...value) ⇒ Integer **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | | --- | --- | | ...value | \* | ### linkedList.pop() ⇒ \* **Kind**: instance method of [LinkedList](#LinkedList) ### linkedList.unshift(...value) ⇒ Integer **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | | --- | --- | | ...value | \* | ### linkedList.shift() ⇒ \* **Kind**: instance method of [LinkedList](#LinkedList) ### linkedList.nodeAt(idx) ⇒ LinkdList.Node **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | | --- | --- | | idx | Integer | ### linkedList.at(idx) ⇒ \* **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | | --- | --- | | idx | Integer | ### linkedList.insert(nodeOrValue, siblingOrIndex) Insert a new value (or an existing node) after the given sibling or index. **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | | --- | --- | | nodeOrValue | [Node](#LinkedList.Node) | \* | | siblingOrIndex | LinkdeList.Node | Integer | ### linkedList.remove(nodeOrIndex) **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | | --- | --- | | nodeOrIndex | [Node](#LinkedList.Node) | Integer | ### linkedList.reset() Reset the list **Kind**: instance method of [LinkedList](#LinkedList) ### linkedList.forEach(fn, [scope]) **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | | --- | --- | | fn | function | | [scope] | Object | ### linkedList.map(fn, [scope]) ⇒ [LinkedList](#LinkedList) **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | | --- | --- | | fn | function | | [scope] | Object | ### linkedList.filter(fn, [scope]) ⇒ [LinkedList](#LinkedList) **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | | --- | --- | | fn | function | | [scope] | Object | ### linkedList.reduce(fn, [value], [scope]) ⇒ \* **Kind**: instance method of [LinkedList](#LinkedList) | Param | Type | Description | | --- | --- | --- | | fn | function | | | [value] | \* | Initial value | | [scope] | Object | Scope to apply to the `fn` passed | ### linkedList.toArray() ⇒ Array.<\*> **Kind**: instance method of [LinkedList](#LinkedList) ### LinkedList.Node ⇐ Object **Kind**: static class of [LinkedList](#LinkedList) **Extends:** Object * [.Node](#LinkedList.Node) ⇐ Object * [new Node(data, [prev], [next])](#new_LinkedList.Node_new) * [.next](#LinkedList.Node+next) * [.prev](#LinkedList.Node+prev) * [.data](#LinkedList.Node+data) * [.insert(prev, next)](#LinkedList.Node+insert) * [.remove()](#LinkedList.Node+remove) #### new Node(data, [prev], [next]) | Param | Type | | --- | --- | | data | Mixed | | [prev] | [Node](#LinkedList.Node) | | [next] | [Node](#LinkedList.Node) | #### node.next **Kind**: instance property of [Node](#LinkedList.Node) **Properties** | Type | | --- | | [Node](#LinkedList.Node) | #### node.prev **Kind**: instance property of [Node](#LinkedList.Node) **Properties** | Type | | --- | | [Node](#LinkedList.Node) | #### node.data **Kind**: instance property of [Node](#LinkedList.Node) **Properties** | Type | | --- | | \* | #### node.insert(prev, next) **Kind**: instance method of [Node](#LinkedList.Node) | Param | Type | | --- | --- | | prev | [Node](#LinkedList.Node) | | next | [Node](#LinkedList.Node) | #### node.remove() Remove the given node, nulling out its prev and next pointers **Kind**: instance method of [Node](#LinkedList.Node) ## Record ⇐ [ProteanClass](#ProteanClass) **Kind**: global class **Extends:** [ProteanClass](#ProteanClass) * [Record](#Record) ⇐ [ProteanClass](#ProteanClass) * [new Record([data])](#new_Record_new) * [.length](#Record+length) * [.get(key)](#Record+get) ⇒ Mixed * [.set(keyOrRecord, [value])](#Record+set) ⇒ [Record](#Record) * [.merge(record)](#Record+merge) ⇒ [Record](#Record) * [.remove(key)](#Record+remove) ⇒ Mixed * [.has(key)](#Record+has) ⇒ Boolean * [.clear()](#Record+clear) ⇒ [Record](#Record) * [.key(idx)](#Record+key) ⇒ String * [.valueOf()](#Record+valueOf) ⇒ Object * [.clone([values])](#Record+clone) ⇒ [Record](#Record) ### new Record([data]) **File:** [utility/record.js](utility/record.js) | Param | Type | | --- | --- | | [data] | Object | ### record.length **Kind**: instance property of [Record](#Record) **Read only**: true **Properties** | Type | | --- | | Integer | ### record.get(key) ⇒ Mixed **Kind**: instance method of [Record](#Record) | Param | Type | | --- | --- | | key | String | ### record.set(keyOrRecord, [value]) ⇒ [Record](#Record) **Kind**: instance method of [Record](#Record) | Param | Type | | --- | --- | | keyOrRecord | String | [Record](#Record) | Object | | [value] | Mixed | ### record.merge(record) ⇒ [Record](#Record) **Kind**: instance method of [Record](#Record) | Param | Type | | --- | --- | | record | [Record](#Record) | Object | ### record.remove(key) ⇒ Mixed **Kind**: instance method of [Record](#Record) | Param | Type | | --- | --- | | key | String | ### record.has(key) ⇒ Boolean **Kind**: instance method of [Record](#Record) | Param | Type | | --- | --- | | key | String | ### record.clear() ⇒ [Record](#Record) **Kind**: instance method of [Record](#Record) ### record.key(idx) ⇒ String **Kind**: instance method of [Record](#Record) | Param | Type | | --- | --- | | idx | Integer | ### record.valueOf() ⇒ Object **Kind**: instance method of [Record](#Record) ### record.clone([values]) ⇒ [Record](#Record) **Kind**: instance method of [Record](#Record) | Param | Type | | --- | --- | | [values] | Object | ## onNextFunction : function **Kind**: global typedef | Param | Type | | --- | --- | | value | Mixed | ## onErrorFunction : function **Kind**: global typedef | Param | Type | | --- | --- | | error | Error | ## onCompletedFunction : function **Kind**: global typedef ## Observable **Kind**: global typedef **Implements:** [Observable](https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/observable.md) ### observable.subscribe(onNextOrObserver, [onError], [onCompleted]) ⇒ [Disposable](#Disposable) **Kind**: instance method of [Observable](#Observable) | Param | Type | | --- | --- | | onNextOrObserver | [onNextFunction](#onNextFunction) | [Observer](#Observer) | | [onError] | [onErrorFunction](#onErrorFunction) | | [onCompleted] | [onCompletedFunction](#onCompletedFunction) | ## Observer **Kind**: global typedef **Implements:** [Observer](https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/observer.md) * [Observer](#Observer) * [.onNext](#Observer+onNext) : [onNextFunction](#onNextFunction) * [.onError](#Observer+onError) : [onErrorFunction](#onErrorFunction) * [.onCompleted](#Observer+onCompleted) : [onCompletedFunction](#onCompletedFunction) ### observer.onNext : [onNextFunction](#onNextFunction) **Kind**: instance property of [Observer](#Observer) ### observer.onError : [onErrorFunction](#onErrorFunction) **Kind**: instance property of [Observer](#Observer) ### observer.onCompleted : [onCompletedFunction](#onCompletedFunction) **Kind**: instance property of [Observer](#Observer) ## Disposable **Kind**: global typedef **Implements:** [Disposable](https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/disposables/disposable.md) ### disposable.dispose() **Kind**: instance method of [Disposable](#Disposable) ## Subject ⇐ [Observable](#Observable) **Kind**: global typedef **Extends:** [Observable](#Observable) **Mixes**: [Observer](#Observer), [Disposable](#Disposable) **See**: [https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/subjects/subject.md](https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/subjects/subject.md) ## DataSource **Kind**: global typedef **Implements:** [DataSource](http://netflix.github.io/falcor/doc/DataSource.html) * [DataSource](#DataSource) * [.get(paths)](#DataSource+get) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.set(envelope)](#DataSource+set) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) * [.call(path, args, refSuffixes, thisPaths)](#DataSource+call) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) ### dataSource.get(paths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [DataSource](#DataSource) | Param | Type | | --- | --- | | paths | [Array.<PathSet>](#PathSet) | ### dataSource.set(envelope) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [DataSource](#DataSource) | Param | Type | | --- | --- | | envelope | [JSONGraphEnvelope](#JSONGraphEnvelope) | ### dataSource.call(path, args, refSuffixes, thisPaths) ⇒ [Observable.<JSONGraphEnvelope>](#JSONGraphEnvelope) **Kind**: instance method of [DataSource](#DataSource) | Param | Type | | --- | --- | | path | [PathSet](#PathSet) | | args | Array.<Mixed> | | refSuffixes | [Array.<PathSet>](#PathSet) | | thisPaths | [Array.<PathSet>](#PathSet) | ## Sentinel : Object **Kind**: global typedef **Properties** | Name | Type | | --- | --- | | $type | String | | value | Mixed | ## Reference : [Sentinel](#Sentinel) **Kind**: global typedef **Properties** | Name | Type | Default | | --- | --- | --- | | $type | String | 'ref' | | value | [Path](#Path) | | ## RootReference : [Reference](#Reference) **Kind**: global typedef **Properties** | Name | Type | Default | | --- | --- | --- | | $root | Boolean | true | ## Atom : [Sentinel](#Sentinel) **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#Atom](http://netflix.github.io/falcor/doc/global.html#Atom) **Properties** | Name | Type | Default | | --- | --- | --- | | $type | String | 'atom' | | $expires | Integer | | ## JSONEnvelope : Object **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#JSONGraph](http://netflix.github.io/falcor/doc/global.html#JSONGraph) **Properties** | Name | Type | | --- | --- | | json | Object | ## JSONGraph : Object **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#JSONGraph](http://netflix.github.io/falcor/doc/global.html#JSONGraph) ## JSONGraphEnvelope : Object **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#JSONGraphEnvelope](http://netflix.github.io/falcor/doc/global.html#JSONGraphEnvelope) **Properties** | Name | Type | | --- | --- | | jsonGraph | [JSONGraph](#JSONGraph) | | paths | [Array.<PathSet>](#PathSet) | | invalidated | [Array.<PathSet>](#PathSet) | ## Key : String | null **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#Key](http://netflix.github.io/falcor/doc/global.html#Key) ## KeySet : [Key](#Key) | [Range](#Range) | Array.<(Key\|Range)> **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#KeySet](http://netflix.github.io/falcor/doc/global.html#KeySet) ## Path : [Array.<Key>](#Key) **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#Path](http://netflix.github.io/falcor/doc/global.html#Path) ## PathSet : [Array.<KeySet>](#KeySet) **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#PathSet](http://netflix.github.io/falcor/doc/global.html#PathSet) ## PathValue : Object **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#PathValue](http://netflix.github.io/falcor/doc/global.html#PathValue) **Properties** | Name | Type | | --- | --- | | path | [Path](#Path) | | value | \* | ## Range : Object **Kind**: global typedef **See**: [http://netflix.github.io/falcor/doc/global.html#Range](http://netflix.github.io/falcor/doc/global.html#Range) **Properties** | Name | Type | | --- | --- | | from | Integer | | to | Integer | | length | Integer | Report an Issue --------------- * [Bugs](http://github.com/jhamlet/protean/issues) * Contact the author: License ------- > Copyright (c) 2015 Jerry Hamlet > > Permission is hereby granted, free of charge, to any person > obtaining a copy of this software and associated documentation > files (the "Software"), to deal in the Software without > restriction, including without limitation the rights to use, > copy, modify, merge, publish, distribute, sublicense, and/or sell > copies of the Software, and to permit persons to whom the > Software is furnished to do so, subject to the following > conditions: > > The above copyright notice and this permission notice shall be > included in all copies or substantial portions of the Software. > > The Software shall be used for Good, not Evil. > > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, > EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES > OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND > NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT > HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, > WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING > FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR > OTHER DEALINGS IN THE SOFTWARE. >