Fork me on GitHub

Namespace: wwwRoot

wwwRoot

A Library of Functions relating to wwwRoot from config

 

Source:

Methods

(static) willDetectFile(relativePath) → {Promise.<Array>}

Parameters:
Name Type Description
relativePath String

a path relative to wwwRoot

Source:
Returns:

a Promise resolving true if a file exists at relativePath

Type
Promise.<Array>

(static) willDetectFile(relativePath) → {Promise.<Array>}

Parameters:
Name Type Description
relativePath String

a path relative to wwwRoot

Source:
Returns:

a Promise resolving true if a file exists at relativePath

Type
Promise.<Array>

(static) willGetFilenames(fileglob) → {Promise.<Array>}

Parameters:
Name Type Description
fileglob String

a path-and-glob-pattern relative to wwwRoot

Source:
Returns:

a Promise resolving the filenames matching fileglob

Type
Promise.<Array>

(static) willGetFilenames(fileglob) → {Promise.<Array>}

Parameters:
Name Type Description
fileglob String

a path-and-glob-pattern relative to wwwRoot

Source:
Returns:

a Promise resolving the filenames matching fileglob

Type
Promise.<Array>

(static) willLoadFile(relativePath) → {Promise.<String>}

Parameters:
Name Type Description
relativePath String

a path relative to wwwRoot

Source:
Returns:

a Promise resolving the contents of the file at relativePath
or a blank String if the file is not present

Type
Promise.<String>

(static) willLoadFile(relativePath) → {Promise.<String>}

Parameters:
Name Type Description
relativePath String

a path relative to wwwRoot

Source:
Returns:

a Promise resolving the contents of the file at relativePath
or a blank String if the file is not present

Type
Promise.<String>

(static) willLoadTSV(relativePath, optionsopt) → {Promise.<Array>}

Parameters:
Name Type Attributes Description
relativePath String

a path relative to wwwRoot

options Object.<Integer> <optional>

options for a csv parser

Source:
See:
Returns:

a Promise resolving the rows of the TSV file at relativePath

Type
Promise.<Array>

(static) willLoadTSV(relativePath, optionsopt) → {Promise.<Array>}

Parameters:
Name Type Attributes Description
relativePath String

a path relative to wwwRoot

options Object.<Integer> <optional>

options for a csv parser

Source:
See:
Returns:

a Promise resolving the rows of the TSV file at relativePath

Type
Promise.<Array>

wwwRoot

A Library of Functions relating to wwwRoot from config

 

Source:

Methods

(static) willDetectFile(relativePath) → {Promise.<Array>}

Parameters:
Name Type Description
relativePath String

a path relative to wwwRoot

Source:
Returns:

a Promise resolving true if a file exists at relativePath

Type
Promise.<Array>

(static) willDetectFile(relativePath) → {Promise.<Array>}

Parameters:
Name Type Description
relativePath String

a path relative to wwwRoot

Source:
Returns:

a Promise resolving true if a file exists at relativePath

Type
Promise.<Array>

(static) willGetFilenames(fileglob) → {Promise.<Array>}

Parameters:
Name Type Description
fileglob String

a path-and-glob-pattern relative to wwwRoot

Source:
Returns:

a Promise resolving the filenames matching fileglob

Type
Promise.<Array>

(static) willGetFilenames(fileglob) → {Promise.<Array>}

Parameters:
Name Type Description
fileglob String

a path-and-glob-pattern relative to wwwRoot

Source:
Returns:

a Promise resolving the filenames matching fileglob

Type
Promise.<Array>

(static) willLoadFile(relativePath) → {Promise.<String>}

Parameters:
Name Type Description
relativePath String

a path relative to wwwRoot

Source:
Returns:

a Promise resolving the contents of the file at relativePath
or a blank String if the file is not present

Type
Promise.<String>

(static) willLoadFile(relativePath) → {Promise.<String>}

Parameters:
Name Type Description
relativePath String

a path relative to wwwRoot

Source:
Returns:

a Promise resolving the contents of the file at relativePath
or a blank String if the file is not present

Type
Promise.<String>

(static) willLoadTSV(relativePath, optionsopt) → {Promise.<Array>}

Parameters:
Name Type Attributes Description
relativePath String

a path relative to wwwRoot

options Object.<Integer> <optional>

options for a csv parser

Source:
See:
Returns:

a Promise resolving the rows of the TSV file at relativePath

Type
Promise.<Array>

(static) willLoadTSV(relativePath, optionsopt) → {Promise.<Array>}

Parameters:
Name Type Attributes Description
relativePath String

a path relative to wwwRoot

options Object.<Integer> <optional>

options for a csv parser

Source:
See:
Returns:

a Promise resolving the rows of the TSV file at relativePath

Type
Promise.<Array>