Global

Methods

buildDefinition(path, deps) → {Definition}

Source:

Build definition.

Parameters:
Name Type Description
path string
deps Dependencies
Returns:
Type
Definition

buildDependencies(pattern, root) → {Dependencies}

Source:

Build dependencies.

Parameters:
Name Type Description
pattern string
root string
Returns:
Type
Dependencies

buildDictionary(paths, deps) → {Dictionary}

Source:

Build dictionary.

Parameters:
Name Type Description
paths Array.<string>
deps Dependencies
Returns:
Type
Dictionary

cleanPath(path, optionsopt) → {string}

Source:

Cleans up a "path", that is, removes trailing slashes, leading slashes or dot-slashes.

Parameters:
Name Type Attributes Default Description
path string
options Object <optional>
 {}
Properties
Name Type Description
beginning boolean
end boolean
Returns:

The cleaned up path

Type
string

run(…sequenceItems) → {runCurry}

Source:

Run a sequence of functions. Has support for functions that return a promise.

Parameters:
Name Type Attributes Description
sequenceItems function | Array.<function(), *> <repeatable>
Returns:
Type
runCurry

Type Definitions

Definition

Source:
Properties:
Name Type Description
path string

e.g. sub/example.ext
entirePath string

e.g. /Users/icidasset/Projects/portfolio/src/templates/sub/example.ext
wd string

e.g. src/templates
root string

e.g. /Users/icidasset/Projects/portfolio
dirname string

e.g. sub
basename string

e.g. example
extname string

e.g. .ext
pattern string

e.g. ** / *.ext (without the spaces)

A dictionary item, a definition.

Type:
  • Object

Dependencies

Source:
Properties:
Name Type Description
pattern string
wd string
root string

A subset of a Definition, is used to initially build a Definition.

Type:
  • Object

Dictionary

Source:

A dictionary.

Type:

runCurry(…args) → {Promise}

Source:

Has different sets of parameters:

Set 1: (glob_pattern, root_directory_path)

Set 2: Dictionary

Set 3: A Promise of a Dictionary

Set 4: No parameters. Will create a sequence with an empty array.

Parameters:
Name Type Attributes Description
args * <repeatable>
Returns:

Returns a promise for a Dictionary

Type
Promise