Module html.CoverageData.Directory

Info:

  • Copyright: 2020 wesen
  • Release: 0.1
  • License: MIT
  • Author: wesen

Class Directory

Directory.childDirectoryCoverageDataCollection The collection for coverages of the child directories
Directory.childFileCoverageDataCollection The collection for coverages of the child files
Directory:new (_directoryName, _parentDirectoryCoverageData) Directory constructor.
Directory:getOrCreateFileCoverageData (_filePath) Returns the File coverage data for a given file path.
Directory:getSortedChildDirectoryCoverages () Returns a list of all child directory coverages sorted ascending by name.
Directory:getSortedChildFileCoverages () Returns a list of all child file coverages sorted ascending by name.


Class Directory

Contains coverage information about a directory and its child file system entries.
Directory.childDirectoryCoverageDataCollection
The collection for coverages of the child directories
  • childDirectoryCoverageDataCollection FileSystemEntryCollection
Directory.childFileCoverageDataCollection
The collection for coverages of the child files
  • childFileCoverageDataCollection FileSystemEntryCollection
Directory:new (_directoryName, _parentDirectoryCoverageData)
Directory constructor.

Parameters:

  • _directoryName string The name of the directory
  • _parentDirectoryCoverageData Directory The coverage data of the parent directory
Directory:getOrCreateFileCoverageData (_filePath)
Returns the File coverage data for a given file path.

If the file is not a direct child of this Directory the request will be passed to the next child Directory in the path.

A new File coverage data object will be created when there is no coverage data for the file yet.

Parameters:

  • _filePath string The file path whose File coverage data to return

Returns:

    File The File coverage data object for the file
Directory:getSortedChildDirectoryCoverages ()
Returns a list of all child directory coverages sorted ascending by name.

Returns:

    Directory[] The sorted list of all child directory coverages
Directory:getSortedChildFileCoverages ()
Returns a list of all child file coverages sorted ascending by name.

Returns:

    File[] The sorted list of all child file coverages
generated by LDoc 1.4.6 Last updated 2020-06-01 14:04:23