Global

Methods

add(name, …prop) → {promise}

Add a named item to the Dynasty collection.
Parameters:
Name Type Attributes Description
name string The name of the item.
prop function <repeatable>
 Various property functions to apply to this item.
Source:
Returns:
No results.
Type
promise

args(…arguments) → {promise.<function()>}

Add arguments to the item builder.
Parameters:
Name Type Attributes Description
arguments any <repeatable>
 Any parameters to use as arguments to the item.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>

attach(…deps) → {promise.<function()>}

Attach and expose dependencies to the item.
Parameters:
Name Type Attributes Description
deps string | object <repeatable>
 Any parameters to use as arguments to the item.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>

call(builder) → {promise.<function()>}

Call a factory function whenever an instance of this object is needed. This is a builder function.
Parameters:
Name Type Description
builder function The factory function to call.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>

collect() → {promise.<function()>}

Collect all attached dependencies into an object that becomes this item's value. This is a builder function.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>

config(value) → {promise}

Merge an object into the configuration. This configuration is exposed to builder functions.
Parameters:
Name Type Description
value object | function Object to merge into the configuration. If function merge the results of the function.
Source:
Returns:
No results.
Type
promise

depends(…deps) → {promise.<function()>}

Add dependencies to the item.
Parameters:
Name Type Attributes Description
deps string | object <repeatable>
 Items to make dependencies of this item.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>

(async) dynasty(callback) → {promise}

Dynasty.
Parameters:
Name Type Description
callback function The configurator callback were everything is setup.
Source:
Returns:
No results.
Type
promise

entryPoint() → {promise.<function()>}

Specify an entry point for the Dynasty collection. There may be multiple entry points. This is a builder function.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>

extend(props) → {promise.<function()>}

Attach values directly to the item.
Parameters:
Name Type Description
props object.<string, any> Any values by key.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>

once(builder) → {promise.<function()>}

Call a factory function once. Additional calls will return the original value. This is a builder function.
Parameters:
Name Type Description
builder function The factory function to call.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>

pullMember(name, member, options) → {promise.<function()>}

Get a member property from an attached dependency and use it as this item. This is a builder function.
Parameters:
Name Type Description
name string The attached dependency to pull from.
member string The member property name to pull.
options object Options.
Properties
Name Type Description
bind boolean If the property is a function bind to parent. Defaults to true.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>

value(contents) → {promise.<function()>}

Supply a value to be used as this item. This is a builder function.
Parameters:
Name Type Description
contents any The value to use.
Source:
Returns:
The resulting parameter function.
Type
promise.<function()>