Module Tools

Index

Functions

Functions

fileDoesNotExists

fileDoesNotExists(pathToFile: string, directiveName: string, scope: "component" | "data-source"): boolean

- Defined in src/tools/file-does-not-exists.function.ts:11
Checks if a file exists.

Parameters
- pathToFile: string
  
  path to the file, needed to check if the file exists and is supported.
- directiveName: string
  
  name of the directive, to be shown in the error message for better identification of the problem.
- scope: "component" | "data-source"
  
  type of element to look for, either a component or a data source.
Returns boolean

true if does not exists

isValidJsonString

isValidJsonString(jsonString: string): boolean

- Defined in src/tools/is-valid-json-string.function.ts:9
Checks if a string is a valid JSON formatted string.

see

https://stackoverflow.com/questions/3710204/how-to-check-if-a-string-is-a-valid-json-string-in-javascript-without-using-try

Parameters
- jsonString: string
  
  String to be checkd
Returns boolean

logDone

logDone(what: string): void

- Defined in src/tools/loggers.function.ts:15
- Minimally formatted message for the console to show what steps of build process have finished.
Parameters
- what: string
  
  name of the step.
Returns void

logStep

logStep(step: string): void

- Defined in src/tools/loggers.function.ts:6
Minimally formatted message for the console to show the progress of the build process.

Parameters
- step: string
  
  where the build process is at.
Returns void

mdTitleExtractor

mdTitleExtractor(mdContents: string): string

- Defined in src/tools/md-title-extractor.function.ts:7
Extracts the first occurence of a level 1 title # [title] from a MarkDown file.

Parameters
- mdContents: string
  
  content of the MarkDown file.
Returns string

the title extracted, if any was found.