protean v0.6.1

Protean

An ever changing set of utilities.

Summary

Installation

% npm install protean

API

Modules

• Protean
  • .Rx
    • .append ⇒ Observable.<String>
    • .mv ⇒ Observable.<String>
    • .fsWrapper ⇒ function
    • .write ⇒ Observable.<String>
    • .from(arg) ⇒ Observable
    • .cp(from, to, [opts]) ⇒ Observable.<fs.Stats>
    • .glob(pattern, [opts]) ⇒ Observable.<String>
    • .isDirectory(paths) ⇒ Observable.<Boolean>
    • .isFile(paths) ⇒ Observable.<Boolean>
    • .mkdir(paths, [opts]) ⇒ Observable.<String>
    • .read(patterns, [enc]) ⇒ Observable.<(String|Buffer)>
    • .rm(patterns, [recursive]) ⇒ Observable.<String>
    • .stat(patterns) ⇒ Observable.<external:fs.Stats>
      • .link(patterns) ⇒ Observable.<external:fs.Stats>
      • .fd(fds) ⇒ Observable.<external:fs.Stats>
  • .denominate ⇒ Object
  • .invoke ⇒ *
  • .pluck ⇒ * | function
  • .classnames(arg) ⇒ String
  • .classify([subclass], props, [properties]) ⇒ ProteanClass
  • .inherit(superclass, [subclass], [props], [properties]) ⇒ ProteanClass
  • .instantiate(fn, [args]) ⇒ Object
  • .augment(...obj) ⇒ Object
  • .enmap(...args) ⇒ Object
  • .enumerate() ⇒ Object
  • .traverse(obj, visitor, [post])
    • static
      • .SKIP : String
      • .CONTINUE : String
      • .BREAK : String
    • inner
      • ~visitorFn(path, value, context) ⇒ undefined | String
  • .guid() ⇒ String
  • .mergeExports(receiver, supplier) ⇒ Object

Protean.Rx

Kind: static property of Protean

• .Rx
  • .append ⇒ Observable.<String>
  • .mv ⇒ Observable.<String>
  • .fsWrapper ⇒ function
  • .write ⇒ Observable.<String>
  • .from(arg) ⇒ Observable
  • .cp(from, to, [opts]) ⇒ Observable.<fs.Stats>
  • .glob(pattern, [opts]) ⇒ Observable.<String>
  • .isDirectory(paths) ⇒ Observable.<Boolean>
  • .isFile(paths) ⇒ Observable.<Boolean>
  • .mkdir(paths, [opts]) ⇒ Observable.<String>
  • .read(patterns, [enc]) ⇒ Observable.<(String|Buffer)>
  • .rm(patterns, [recursive]) ⇒ Observable.<String>
  • .stat(patterns) ⇒ Observable.<external:fs.Stats>
    • .link(patterns) ⇒ Observable.<external:fs.Stats>
    • .fd(fds) ⇒ Observable.<external:fs.Stats>

Rx.append ⇒ Observable.<String>

Kind: static property of Rx

Rx.mv ⇒ Observable.<String>

File: rx/fs/mv.js

Kind: static property of Rx

Rx.fsWrapper ⇒ function

Kind: static property of Rx

Rx.write ⇒ Observable.<String>

Kind: static property of Rx

Rx.from(arg) ⇒ Observable

File: rx/from.js

Kind: static method of Rx

Rx.cp(from, to, opts) ⇒ Observable.<fs.Stats>

File: rx/fs/cp.js

Kind: static method of Rx

Rx.glob(pattern, opts) ⇒ Observable.<String>

File: rx/glob.js

Kind: static method of Rx
Returns: Observable.<String> - An Observable emiting the paths found

Rx.isDirectory(paths) ⇒ Observable.<Boolean>

File: rx/is-directory.js

Kind: static method of Rx
Returns: Observable.<Boolean> - An Observable emiting the paths found

Rx.isFile(paths) ⇒ Observable.<Boolean>

File: rx/is-file.js

Kind: static method of Rx

Rx.mkdir(paths, opts) ⇒ Observable.<String>

Create the given paths in the file system.

File: rx/mkdir.js

Kind: static method of Rx

Rx.read(patterns, enc) ⇒ Observable.<(String|Buffer)>

File: rx/read.js

Kind: static method of Rx

Rx.rm(patterns, recursive) ⇒ Observable.<String>

File: rx/rm.js

Kind: static method of Rx

Rx.stat(patterns) ⇒ Observable.<external:fs.Stats>

File: rx/stat.js

Kind: static method of Rx
Returns: Observable.<external:fs.Stats> - An Observable emiting the paths found

• .stat(patterns) ⇒ Observable.<external:fs.Stats>
  • .link(patterns) ⇒ Observable.<external:fs.Stats>
  • .fd(fds) ⇒ Observable.<external:fs.Stats>

stat.link(patterns) ⇒ Observable.<external:fs.Stats>

Kind: static method of stat

stat.fd(fds) ⇒ Observable.<external:fs.Stats>

Kind: static method of stat

Protean.denominate ⇒ Object

Kind: static property of Protean
Returns: Object - The object now with a immutable 'name' property of the given name value

Protean.invoke ⇒ *

Kind: static property of Protean

Protean.pluck ⇒ * | function

File: object/pluck.js

Kind: static property of Protean

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

Kind: static method of Protean

Protean.classify(subclass, props, properties) ⇒ ProteanClass

Create a constructor function passing in it's prototype methods.

File: function/classify

Kind: static method of Protean

Protean.inherit(superclass, subclass, props, properties) ⇒ ProteanClass

Create a constructor function that inherits properties and methods from the given super constructor.

File: function/inherit.js

Kind: static method of Protean
Returns: ProteanClass - The constructor function.

Protean.instantiate(fn, args) ⇒ Object

Create a new object and then apply the constructor function with the arguments.

File: function/instantiate.js

Kind: static method of Protean
Returns: Object - The new instance

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

Kind: static method of Protean

Protean.enmap(...args) ⇒ Object

Takes a list of alternating key/values and returns an object.

File: object/enmap.js

Kind: static method of Protean

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

Kind: static method of Protean

Protean.traverse(obj, visitor, post)

Kind: static method of Protean

• .traverse(obj, visitor, [post])
  • static
    • .SKIP : String
    • .CONTINUE : String
    • .BREAK : String
  • inner
    • ~visitorFn(path, value, context) ⇒ undefined | String

traverse.SKIP : String

Kind: static constant of traverse

traverse.CONTINUE : String

Kind: static constant of traverse

traverse.BREAK : String

Kind: static constant of traverse

traverse~visitorFn(path, value, context) ⇒ undefined | String

File: object/traverse.js

Kind: inner method of traverse
Returns: undefined | String - One of the constants of 'skip', 'continue', or 'break'. Returning undefined is the same as returing 'continue'.

Protean.guid() ⇒ String

Fast GUID generator, RFC4122 version 4 compliant.

File: utility/guid.js

Kind: static method of 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

Kind: static method of Protean

Falcor

• Falcor
  • .Graph
    • .set ⇒ Object
    • .atoms(graph, fn)
      • ~visitorFn(path, atom, graph)
    • .fromObject(obj, [opts]) ⇒ JSONGraph
    • .isAtom(sentinel) ⇒ Boolean
    • .isError(sentinel) ⇒ Boolean
    • .isRef(sentinel) ⇒ Boolean
    • .isRootRef(sentinel) ⇒ Boolean
    • .isSentinel(sentinel) ⇒ Boolean
    • .refs(graph, fn)
      • ~visitorFn(path, ref, graph)
    • .relative(root, graph) ⇒ JSONGraph
    • .resolve(root, graph) ⇒ JSONGraph
    • .rootRef(path, value, props) ⇒ Reference
    • .sentinels(graph, fn)
      • ~visitorFn(path, sentinel, graph)
    • .toObject(graph, [opts]) ⇒ JSONGraph
  • .Path
    • .relative(root, paths) ⇒ Array.<PathSet>
    • .resolve(root, paths) ⇒ Array.<PathSet>

Falcor.Graph

File: falcor/graph.js

Kind: static property of Falcor
See: https://github.com/Netflix/falcor-json-graph

• .Graph
  • .set ⇒ Object
  • .atoms(graph, fn)
    • ~visitorFn(path, atom, graph)
  • .fromObject(obj, [opts]) ⇒ JSONGraph
  • .isAtom(sentinel) ⇒ Boolean
  • .isError(sentinel) ⇒ Boolean
  • .isRef(sentinel) ⇒ Boolean
  • .isRootRef(sentinel) ⇒ Boolean
  • .isSentinel(sentinel) ⇒ Boolean
  • .refs(graph, fn)
    • ~visitorFn(path, ref, graph)
  • .relative(root, graph) ⇒ JSONGraph
  • .resolve(root, graph) ⇒ JSONGraph
  • .rootRef(path, value, props) ⇒ Reference
  • .sentinels(graph, fn)
    • ~visitorFn(path, sentinel, graph)
  • .toObject(graph, [opts]) ⇒ JSONGraph

Graph.set ⇒ Object

File: falcor/graph/set.js

Kind: static property of Graph

Graph.atoms(graph, fn)

File: falcor/graph/atoms.js

Kind: static method of Graph

atoms~visitorFn(path, atom, graph)

Kind: inner method of atoms

Graph.fromObject(obj, opts) ⇒ JSONGraph

Takes a normal javascript object and returns a JSONGraph.

File: falcor/graph/from-object.js

Kind: static method of Graph

Graph.isAtom(sentinel) ⇒ Boolean

File: falcor/graph/is-atom.js

Kind: static method of Graph

Graph.isError(sentinel) ⇒ Boolean

File: falcor/graph/is-error.js

Kind: static method of Graph

Graph.isRef(sentinel) ⇒ Boolean

File: falcor/graph/is-ref.js

Kind: static method of Graph

Graph.isRootRef(sentinel) ⇒ Boolean

File: falcor/graph/is-root-ref.js

Kind: static method of Graph

Graph.isSentinel(sentinel) ⇒ Boolean

File: falcor/graph/is-sentinel.js

Kind: static method of Graph

Graph.refs(graph, fn)

File: falcor/graph/refs.js

Kind: static method of Graph

refs~visitorFn(path, ref, graph)

Kind: inner method of refs

Graph.relative(root, graph) ⇒ JSONGraph

File: falcor/graph/relative.js

Kind: static method of Graph

Graph.resolve(root, graph) ⇒ JSONGraph

File: falcor/graph/resolve.js

Kind: static method of Graph

Graph.rootRef(path, value, props) ⇒ Reference

File: falcor/graph/root-ref.js

Kind: static method of Graph

Graph.sentinels(graph, fn)

File: falcor/graph/sentinels.js

Kind: static method of Graph

sentinels~visitorFn(path, sentinel, graph)

Kind: inner method of sentinels

Graph.toObject(graph, opts) ⇒ JSONGraph

Takes a JSONGraph and returns a Javascript Object.

File: falcor/graph/to-object.js

Kind: static method of Graph

Falcor.Path

Kind: static property of Falcor
See: https://github.com/Netflix/falcor-path-utils

• .Path
  • .relative(root, paths) ⇒ Array.<PathSet>
  • .resolve(root, paths) ⇒ Array.<PathSet>

Path.relative(root, paths) ⇒ Array.<PathSet>

File: falcor/path/relative.js

Kind: static method of Path

Path.resolve(root, paths) ⇒ Array.<PathSet>

File: falcor/path/resolve.js

Kind: static method of Path

CollectionSource ⇐ ProteanClass

Kind: global class
Extends: ProteanClass
Implements: DataSource

• CollectionSource ⇐ ProteanClass
  • new CollectionSource([collection], [opts])
  • .options
    • .indexedPath
    • .keyedPath
    • .lengthPath
    • .addPath
    • .removePath
  • .router
  • .routes
  • .get(paths) ⇒ Observable.<JSONGraphEnvelope>
  • .set(envelope) ⇒ Observable.<JSONGraphEnvelope>
  • .call(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>
  • .getLength() ⇒ Observable.<JSONGraphEnvelope>
  • .getRecordByIndex(paths) ⇒ Observable.<JSONGraphEnvelope>
  • .getRecordProps(paths) ⇒ Observable.<JSONGraphEnvelope>
  • .setRecordProps(graph) ⇒ Observable.<JSONGraphEnvelope>
  • .addRecord(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>
  • .removeRecord(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>

new CollectionSource(collection, opts)

file: falcor/data-source/collection.js

collectionSource.options

Default options

Kind: instance property of CollectionSource
Properties

• .options
  • .indexedPath
  • .keyedPath
  • .lengthPath
  • .addPath
  • .removePath

options.indexedPath

Kind: static property of options
Properties

options.keyedPath

Kind: static property of options
Properties

options.lengthPath

Kind: static property of options
Properties

options.addPath

Kind: static property of options
Properties

options.removePath

Kind: static property of options
Properties

collectionSource.router

Kind: instance property of CollectionSource
See: http://netflix.github.io/falcor/documentation/router.html
Properties

collectionSource.routes

Kind: instance property of CollectionSource
Properties

collectionSource.get(paths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CollectionSource
Implements: get

collectionSource.set(envelope) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CollectionSource
Implements: set

collectionSource.call(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CollectionSource
Implements: call

collectionSource.getLength() ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CollectionSource

collectionSource.getRecordByIndex(paths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CollectionSource

collectionSource.getRecordProps(paths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CollectionSource

collectionSource.setRecordProps(graph) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CollectionSource

collectionSource.addRecord(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CollectionSource

collectionSource.removeRecord(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CollectionSource

CompositeSource ⇐ ProteanClass

Kind: global class
Extends: ProteanClass
Implements: DataSource

• CompositeSource ⇐ ProteanClass
  • new CompositeSource(...args)
  • .sources
  • .get(paths) ⇒ Observable.<JSONGraphEnvelope>
  • .set(envelope) ⇒ Observable.<JSONGraphEnvelope>
  • .call(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>
  • .add(path, source) ⇒ CompositeSource

new CompositeSource(...args)

A DataSource that allows for composing several different DataSources together through different Paths.

This allows individual DataSources 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 Paths and the resulting Graph so it appears that everything comes from a larger Graph.

Basically, all returned Paths/Graphs are updated to have any references relative to their Paths 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 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

compositeSource.sources

Kind: instance property of CompositeSource
Properties

compositeSource.get(paths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CompositeSource
Implements: get

compositeSource.set(envelope) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CompositeSource
Implements: set

compositeSource.call(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of CompositeSource
Implements: call

compositeSource.add(path, source) ⇒ CompositeSource

Kind: instance method of CompositeSource
Returns: CompositeSource - the CompositeSource instance

JSONGraphEnvelopeProxy ⇐ ProteanClass

Kind: global class
Extends: ProteanClass
Implements: JSONGraphEnevelope

• JSONGraphEnvelopeProxy ⇐ ProteanClass
  • new JSONGraphEnvelopeProxy([opts])
  • .paths
  • .jsonGraph
  • .invalidated
  • .expecting
  • .pending
  • .set(pathOrGraph, [atom])
  • .invalidate(...path)
  • .fulfill(path)
  • .expect(paths)
  • .relativeFrom(from) ⇒ JSONGraphEnvelopeProxy
  • .resolvedFrom(from) ⇒ JSONGraphEnvelopeProxy
  • .merge(other)
  • .destroy()
  • .clone() ⇒ JSONGraphEnvelopeProxy
  • .valueOf() ⇒ JSONGraphEnvelope
  • .finalize() ⇒ JSONGraphEnvelope

new JSONGraphEnvelopeProxy(opts)

jsonGraphEnvelopeProxy.paths

Kind: instance property of JSONGraphEnvelopeProxy
Properties

jsonGraphEnvelopeProxy.jsonGraph

Kind: instance property of JSONGraphEnvelopeProxy
Properties

jsonGraphEnvelopeProxy.invalidated

Kind: instance property of JSONGraphEnvelopeProxy
Properties

jsonGraphEnvelopeProxy.expecting

Kind: instance property of JSONGraphEnvelopeProxy
Properties

jsonGraphEnvelopeProxy.pending

Get a list of paths this envelope is still expecting to fulfill

Kind: instance property of JSONGraphEnvelopeProxy
Read only: true
Properties

jsonGraphEnvelopeProxy.set(pathOrGraph, atom)

Kind: instance method of JSONGraphEnvelopeProxy

jsonGraphEnvelopeProxy.invalidate(...path)

Kind: instance method of JSONGraphEnvelopeProxy

jsonGraphEnvelopeProxy.fulfill(path)

Mark a path as fulfilled and set the given value on our jsonGraph

Kind: instance method of JSONGraphEnvelopeProxy

jsonGraphEnvelopeProxy.expect(paths)

Prepare this envelope to expect to fulfill a certain set of paths.

Kind: instance method of JSONGraphEnvelopeProxy

jsonGraphEnvelopeProxy.relativeFrom(from) ⇒ JSONGraphEnvelopeProxy

Kind: instance method of JSONGraphEnvelopeProxy
Returns: JSONGraphEnvelopeProxy - A copy

jsonGraphEnvelopeProxy.resolvedFrom(from) ⇒ JSONGraphEnvelopeProxy

Kind: instance method of JSONGraphEnvelopeProxy
Returns: JSONGraphEnvelopeProxy - A copy

jsonGraphEnvelopeProxy.merge(other)

Merge another JSONGraphEnvelope into this one

Kind: instance method of JSONGraphEnvelopeProxy

jsonGraphEnvelopeProxy.destroy()

Clear out our data so we do not have any dangling memory.

Kind: instance method of JSONGraphEnvelopeProxy

jsonGraphEnvelopeProxy.clone() ⇒ JSONGraphEnvelopeProxy

Get a copy of this proxy

Kind: instance method of JSONGraphEnvelopeProxy

jsonGraphEnvelopeProxy.valueOf() ⇒ JSONGraphEnvelope

Kind: instance method of JSONGraphEnvelopeProxy

jsonGraphEnvelopeProxy.finalize() ⇒ JSONGraphEnvelope

Kind: instance method of JSONGraphEnvelopeProxy

NoCacheSource ⇐ ProteanClass

Kind: global class
Extends: ProteanClass
Implements: DataSource

• NoCacheSource ⇐ ProteanClass
  • new NoCacheSource(opts)
  • .get(paths) ⇒ Observable.<JSONGraphEnvelope>
  • .set(envelope) ⇒ Observable.<JSONGraphEnvelope>
  • .call(path, args, refSuffixes, thisPaths) ⇒ Observable.<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

noCacheSource.get(paths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of NoCacheSource
Implements: get

noCacheSource.set(envelope) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of NoCacheSource
Implements: set

noCacheSource.call(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of NoCacheSource
Implements: call

PartitionedSource ⇐ ProteanClass

Kind: global class
Extends: ProteanClass
Implements: DataSource

• PartitionedSource ⇐ ProteanClass
  • new PartitionedSource([opts])
  • .options
    • .reads
    • .writes
    • .partitions
  • .get(paths) ⇒ Observable.<JSONGraphEnvelope>
  • .set(envelope) ⇒ Observable.<JSONGraphEnvelope>
  • .call(path, args, refSuffixes, thisPaths) ⇒ Observable.<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.

partitionedSource.options

Default options

Kind: instance property of PartitionedSource
Properties

• .options
  • .reads
  • .writes
  • .partitions

options.reads

Kind: static property of options
Properties

options.writes

Kind: static property of options
Properties

options.partitions

Kind: static property of options
Properties

partitionedSource.get(paths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of PartitionedSource
Implements: get

partitionedSource.set(envelope) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of PartitionedSource
Implements: set

partitionedSource.call(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of PartitionedSource
Implements: call

ProxiedSource ⇐ ProteanClass

Kind: global class
Extends: ProteanClass
Implements: DataSource

• ProxiedSource ⇐ ProteanClass
  • new ProxiedSource([opts])
  • .source
  • .root
  • .get(paths) ⇒ Observable.<JSONGraphEnvelope>
  • .set(envelope) ⇒ Observable.<JSONGraphEnvelope>
  • .call(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>
  • .willGet(paths) ⇒ Boolean
  • .willSet(envelope) ⇒ Boolean
  • .willCall(path) ⇒ Boolean
  • .getRelativeEnvelope(envelope) ⇒ JSONGraphEnvelope
  • .getResolvedEnvelope(envelope) ⇒ 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

proxiedSource.source

Kind: instance property of ProxiedSource
Properties

proxiedSource.root

Kind: instance property of ProxiedSource
Properties

proxiedSource.get(paths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of ProxiedSource
Implements: get

proxiedSource.set(envelope) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of ProxiedSource
Implements: set

proxiedSource.call(path, args, refSuffixes, thisPaths) ⇒ Observable.<JSONGraphEnvelope>

Kind: instance method of ProxiedSource
Implements: call

proxiedSource.willGet(paths) ⇒ Boolean

Will the given paths be consumed by a get request against this datasource?

Kind: instance method of ProxiedSource

proxiedSource.willSet(envelope) ⇒ Boolean

Will the given JSONGraphEnvelope be consumed by a set request against this datasource?

Kind: instance method of ProxiedSource

proxiedSource.willCall(path) ⇒ Boolean

Will the given path be consumed by a call request against this datasource?

Kind: instance method of ProxiedSource

proxiedSource.getRelativeEnvelope(envelope) ⇒ JSONGraphEnvelope

Strip our leading path from the envelope's path(s) and jsonGraph object.

Kind: instance method of ProxiedSource

proxiedSource.getResolvedEnvelope(envelope) ⇒ JSONGraphEnvelope

Adjust the JSONGraphEnvelope to reflect our leading path information.

Kind: instance method of ProxiedSource

StorageSource ⇐ ProteanClass

Kind: global class
Extends: ProteanClass
Implements: DataSource

• StorageSource ⇐ ProteanClass
  • new StorageSource(opts)
  • .model
  • .source
  • [.op