v0.4.4

Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only
index / ts-docs / fileHost / FileHost

Interface FileHostsince 4.0.1

Defined in index.ts

Properties

exists: (path: string) => boolean

Checks if the provided path exists.

createFile: (
basePath: string,
folderName: string,
fileName: string,
content: string
) => string

Creates a file with the name fileName, which is located inside folderName, which gets created if it doesn't already exist. The folder is located in the basePath.

Returns

The basePath + folderName.
copyFolder: (origin: string, destination: string) => void

Copies an entire folder and everything inside it, including contents of sub-folders.

createDir: (path: string, name: string) => string

Creates a folder only if it doesn't already exists.

Returns

The path + name
getDocumentStructure: (name: string) => DocumentStructuretype DocumentStructurets-docs/documentStructure/DocumentStructure | false

Returns

The documentation structure object, or false to let ts-docs find it on it's own. Keep in mind it won't use the methods provided by the file host.
readFile: (path: string) => string
writeFile: (path: string, content: string) => void