Module html.Writer.Path.OutputPathGenerator
Info:
- Copyright: 2020 wesen
- Release: 0.1
- License: MIT
- Author: wesen
Class OutputPathGenerator
| OutputPathGenerator.baseOutputDirectoryPath | The path to the base output directory |
| OutputPathGenerator.coverageDataOutputFilePaths | The cached output file paths for FileSystemEntry coverage data objects
This list is in the format { [ |
| OutputPathGenerator:new (_baseOutputDirectoryPath) | OutputPathGenerator constructor. |
| OutputPathGenerator:generateRelativePath (_fromFileSystemEntryCoverageData, _toFileSystemEntryCoverageData, _includeBaseName) | Generates a path to a FileSystemEntry coverage data object that is relative from another FileSystemEntry coverage data object. |
| OutputPathGenerator:generateOutputFilePathForCoverageData (_fileSystemEntryCoverageData) | Generates the full path for a FileSystemEntry's output HTML file. |
| OutputPathGenerator:generateOutputFilePathForRelativePath (_relativePath) | Generates the total output file path from a file path that is relative from the base output directory. |
Class OutputPathGenerator
Generates the output file paths for the generated HTML files.
- OutputPathGenerator.baseOutputDirectoryPath
-
The path to the base output directory
- baseOutputDirectoryPath string
- OutputPathGenerator.coverageDataOutputFilePaths
-
The cached output file paths for FileSystemEntry coverage data objects
This list is in the format { [
] = , ... } - coverageDataOutputFilePaths table
- OutputPathGenerator:new (_baseOutputDirectoryPath)
-
OutputPathGenerator constructor.
Parameters:
- _baseOutputDirectoryPath string The path to the base output directory
- OutputPathGenerator:generateRelativePath (_fromFileSystemEntryCoverageData, _toFileSystemEntryCoverageData, _includeBaseName)
-
Generates a path to a FileSystemEntry coverage data object that is relative from another
FileSystemEntry coverage data object.
Parameters:
- _fromFileSystemEntryCoverageData CoverageData.FileSystemEntry The start of the relative path
- _toFileSystemEntryCoverageData CoverageData.FileSystemEntry The end of the relative path
- _includeBaseName bool True to include the base name of the second FileSystemEntry in the generated path, false otherwise
Returns:
-
string
The relative path from the first FileSystemEntry to the other
- OutputPathGenerator:generateOutputFilePathForCoverageData (_fileSystemEntryCoverageData)
-
Generates the full path for a FileSystemEntry's output HTML file.
Parameters:
- _fileSystemEntryCoverageData CoverageData.FileSystemEntry The FileSystemEntry coverage data object
Returns:
-
string
The full path for the FileSystemEntry's output HTML file
- OutputPathGenerator:generateOutputFilePathForRelativePath (_relativePath)
-
Generates the total output file path from a file path that is relative from the base output directory.
Parameters:
- _relativePath string The relative path
Returns:
-
string
The total output file path