File: path.coffee

Defined in:

Method Summary

? (void) makeKey(model, path, subclasses) Produce a key suitable for indexing paths with.
? (PathInfo) PathInfo.parse(model, path, subclasses = {}) Parse a string, or stringable thing, into a PathInfo object, given a model to describe the data model and a listing of the optional subclass constraints.
? (void) PathInfo.flushCache() Remove cached instances from memory.

Method Details

? (void) makeKey(model, path, subclasses)

Produce a key suitable for indexing paths with.

? (PathInfo) PathInfo.parse(model, path, subclasses = {})

Parse a string, or stringable thing, into a PathInfo object, given a model to describe the data model and a listing of the optional subclass constraints.

@subclasses [Object] The subclass constraints to bear in mind. (Optional).

@throws if this path is invalid.

Parameters:

model (Model) — The data model to validate against.
The (#toString) — path to interpret.

Returns:

(PathInfo) — The path information for this path.

? (void) PathInfo.flushCache()

Remove cached instances from memory. Could be useful in long lived instances.