Module utils/files.utils

Index

Type aliases

FileWriter

Functions

Type aliases

FileWriter

FileWriter: (content: string, fileType: FileType, fileExtension: FileExtension) => void

Type declaration

- (content: string, fileType: FileType, fileExtension: FileExtension): void
- Parameters
  - content: string
  - fileType: FileType
  - fileExtension: FileExtension
  Returns void

Functions

createOrReplaceDir

createOrReplaceDir(path: string): FileWriter

- Defined in utils/files.utils.ts:17
Create a directory if it doesn't exist, or remove the content if it does.

Parameters
- path: string
  
  The path to the directory.
Returns FileWriter
- A function that writes the content to a file in that directory.

progLangToFileExtension

progLangToFileExtension(progLang: ProgrammingLanguage): FileExtension

- Defined in utils/files.utils.ts:71
Transfrom a programming language to a file extension.

Parameters
- progLang: ProgrammingLanguage
  
  The programming language.
Returns FileExtension
The file extension associated to the lang.

readTemplateRunFile

readTemplateRunFile(fileExtension: FileExtension): string

- Defined in utils/files.utils.ts:58
Read the run template file.

Parameters
- fileExtension: FileExtension
  
  The file extension of the template file.
Returns string
The content of the template file.

readTemplateTestFile

readTemplateTestFile(fileExtension: FileExtension, minifyContent?: Boolean): Promise<string>

- Defined in utils/files.utils.ts:38
Read the template file and minimize if needed.

async
Parameters
- fileExtension: FileExtension
  
  The file extension of the template file.
- minifyContent: Boolean = true
Returns Promise<string>
- The content of the template file.

Generated using TypeDoc