Interface ScopedGhostService
Methods
deleteFile
- deleteFile(rootFolder: string, file: string): Promise<void>
-
Parameters
-
rootFolder: string
-
file: string
Returns Promise<void>
directoryListing
- directoryListing(rootFolder: string, fileEndingPattern: string, exclude?: string | string[], includeDotFiles?: boolean, options?: DirectoryListingOptions): Promise<string[]>
-
Parameters
-
rootFolder: string
-
fileEndingPattern: string
-
Optional exclude: string | string[]
-
Optional includeDotFiles: boolean
-
Returns Promise<string[]>
fileExists
- fileExists(rootFolder: string, file: string): Promise<boolean>
-
Parameters
-
rootFolder: string
-
file: string
Returns Promise<boolean>
readFileAsBuffer
- readFileAsBuffer(rootFolder: string, file: string): Promise<Buffer>
-
Parameters
-
rootFolder: string
-
file: string
Returns Promise<Buffer>
readFileAsObject
- readFileAsObject<T>(rootFolder: string, file: string): Promise<T>
-
Type parameters
Parameters
-
rootFolder: string
-
file: string
Returns Promise<T>
readFileAsString
- readFileAsString(rootFolder: string, file: string): Promise<string>
-
Parameters
-
rootFolder: string
-
file: string
Returns Promise<string>
renameFile
- renameFile(rootFolder: string, fromName: string, toName: string): Promise<void>
-
Parameters
-
rootFolder: string
-
fromName: string
-
toName: string
Returns Promise<void>
upsertFile
- upsertFile(rootFolder: string, file: string, content: string | Buffer, options?: UpsertOptions): Promise<void>
-
Parameters
-
rootFolder: string
-
file: string
-
content: string | Buffer
-
Returns Promise<void>