UIZE JavaScript Framework

MODULES Uize.Util.Dependencies

1. Introduction

The Uize.Util.Dependencies utility module provides methods for working with dependency relationships in a generic way.

DEVELOPERS: Chris van Rensburg

While the Uize.Util.Dependencies module is used by the Uize.Build.ModuleInfo build utility module to trace module dependencies, the methods of the Uize.Util.Dependencies module are expressed in sufficiently generic terms that the module can be used for many types of items that have dependency relationships.

1.1. Examples

There are no dedicated showcase example pages for the Uize.Util.Dependencies module.


Use the link below to search for example pages on the UIZE Web site that reference the Uize.Util.Dependencies module...


1.2. Implementation Info

The Uize.Util.Dependencies module defines the Uize.Util.Dependencies package under the Uize.Util namespace.

1.2.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.


Uize.Util.Dependencies.resolveDependenciesList | Uize.Util.Dependencies.traceDependencies


Uize.Util.Dependencies.moduleName | Uize.Util.Dependencies.pathToResources

1.2.2. Features Overridden in This Module

No features have been overridden in this module.

1.2.3. Features Inherited From Other Modules

This module has no inherited features.

1.2.4. Modules Directly Under This Namespace

1.2.5. Unit Tests

There is no dedicated unit tests module for the Uize.Util.Dependencies module.

2. Static Methods

2.1. Uize.Util.Dependencies.resolveDependenciesList


this feature was introduced in this module

2.2. Uize.Util.Dependencies.traceDependencies

Returns an array, containing the dependencies that are required - both directly and indirectly - by the specified root dependency (or dependencies), and excluding the optionally specified exclude list.


dependenciesARRAY = Uize.Util.Dependencies.traceDependencies (
  excludeDependenciesSTRorARRAY  // optional

The Uize.Util.Dependencies.traceDependencies method can be used to trace all the dependencies for a specified set of one or more root level dependencies. Dependencies, which are specified by name, can be of any type - modules, needs, conditions, barriers, derived values, etc.

2.2.1. Parameters

The Uize.Util.Dependencies.traceDependencies method takes the following parameters...

rootDependenciesSTRorARRAY - either a string, containing a comma-separated list of the root dependencies, or a string array of the root dependencies
getDirectDependenciesFUNC - a function that should expect to receive a single string parameter representing the name of a dependency, and that should return an array of the dependency's direct dependencies
excludeDependenciesSTRorARRAY - an optional string, containing a comma-separated list of dependencies to exclude, or a string array of the dependencies to exclude

In order for this method to be able to trace dependencies, a function must be specified for the getDirectDependenciesFUNC parameter that can be used to obtain a list of the direct dependencies for any given dependency. Provided with this function, the Uize.Util.Dependencies.traceDependencies method can recursively trace out the dependency list and return the list of all dependencies - both direct and indirect - listed in dependency order and ASCIIbetically sub-sorted.


var directDepsLookup = {

function getDirectDeps (dep) {
  return directDepsLookup [dep];

alert (  // alerts "qux,baz,bar,foo"
  Uize.Util.Dependencies.traceDependencies (['foo','qux'],getDirectDeps)

alert (  // alerts "qux,baz"
  Uize.Util.Dependencies.traceDependencies ('baz',getDirectDeps)

alert (  // alerts "baz,bar,foo"
  Uize.Util.Dependencies.traceDependencies ('foo',getDirectDeps,['qux'])

The above example is very hypothetical and over simplified, but it demonstrates the basics of how the Uize.Util.Dependencies.traceDependencies method can be used.

In the example, we have created a directDepsLookup object, which maps the names of dependencies to their direct dependencies (it's not important what type of things we're dealing with). Then, we've created a simple getDirectDeps function that looks up the direct dependencies for a specified dependency from the directDepsLookup lookup and returns those dependencies. When we call the Uize.Util.Dependencies.traceDependencies method, we supply the getDirectDeps function for the method's getDirectDependenciesFUNC parameter.

In a real world usage, the function value provided for the getDirectDependenciesFUNC parameter would have an understanding of the type of dependencies that are being dealt with. This approach provides the maximum flexibility for the user of the Uize.Util.Dependencies.traceDependencies method, keeping the responsibility of this method to simply performing the recursive tracing algorithm.


compare to the related Uize.Util.Dependencies.getDirectDependencies static method


this feature was introduced in this module

3. Static Properties

3.1. Uize.Util.Dependencies.moduleName


this feature was introduced in this module

3.2. Uize.Util.Dependencies.pathToResources


this feature was introduced in this module