Class FileSystem

constructor

• new FileSystem(targetDirectory?: string, filterPaths?: string[]): FileSystem

  Parameters

  • targetDirectory: string = '.'
  • filterPaths: string[] = []

  Returns FileSystem

filterPaths

targetDirectory

findAll

• findAll(globs: string | string[], isNocase?: boolean): Promise<string[]>

  Parameters

  • globs: string | string[]
  • isNocase: boolean = false

  Returns Promise<string[]>

findAllFiles

• findAllFiles(globs: string | string[], isNocase?: boolean): Promise<string[]>

  Parameters

  • globs: string | string[]
  • OptionalisNocase: boolean

  Returns Promise<string[]>

findFirst

• findFirst(
      globs: string | string[],
      isNocase?: boolean,
  ): Promise<string | undefined>

  Parameters

  • globs: string | string[]
  • OptionalisNocase: boolean

  Returns Promise<string | undefined>

findFirstFile

• findFirstFile(
      globs: string | string[],
      isNocase?: boolean,
  ): Promise<string | undefined>

  Parameters

  • globs: string | string[]
  • OptionalisNocase: boolean

  Returns Promise<string | undefined>

getFileContents

• getFileContents(relativeFile: string): Promise<string | undefined>

  Parameters

  • relativeFile: string

  Returns Promise<string | undefined>

getFileLines

• getFileLines(
      relativeFile: string,
      lineCount: number,
  ): Promise<string | undefined>

  Parameters

  • relativeFile: string
  • lineCount: number

  Returns Promise<string | undefined>

glob

• glob(globs: string | string[], options: GlobOptions): Promise<string[]>

  Parameters

  • globs: string | string[]
  • options: GlobOptions

  Returns Promise<string[]>

isBinaryFile

• isBinaryFile(relativeFile: string): Promise<boolean>

  Parameters

  • relativeFile: string

  Returns Promise<boolean>

normalizePath

• normalizePath(filepath: string): string

  Parameters

  • filepath: string

  Returns string

relativeFileExists

• relativeFileExists(file: string): Promise<boolean>

  Parameters

  • file: string

  Returns Promise<boolean>

removeFile

• removeFile(relativeFile: string): Promise<void>

  Parameters

  • relativeFile: string

  Returns Promise<void>

resolveContained

• resolveContained(relativeFile: string): string

  Parameters

  • relativeFile: string

  Returns string

setFileContents

• setFileContents(relativeFile: string, contents: string): Promise<void>

  Parameters

  • relativeFile: string
  • contents: string

  Returns Promise<void>

shouldInclude

• shouldInclude(filePath: string): boolean

  Parameters

  • filePath: string

  Returns boolean

StaticfileExists

• fileExists(file: string): Promise<boolean>

  Parameters

  • file: string

  Returns Promise<boolean>