Class File

constructor

• new File(path, opts?): File

• Parameters

  • path: string | class_Uri

  • Optional opts: IFileSettings

  Returns File

content

Optional opts

Optional sourceMap

uri

Static middleware

Static Factory

• get Factory(): FileFactory

• Returns FileFactory

Static Middleware

• get Middleware(): FileHooks

• Returns FileHooks

append

• append(str): boolean

• Parameters

  • str: string

  Returns boolean

appendAsync

• appendAsync(str): IDeferred<boolean>

• Parameters

  • str: string

  Returns IDeferred<boolean>

copyTo

• copyTo(target, opts?): this

• Parameters

  • target: string

  • Optional opts: IFileCopyOpts

  Returns this

copyToAsync

• copyToAsync(target, opts?): IDeferred<File>

• Parameters

  • target: string

  • Optional opts: IFileCopyOpts

  Returns IDeferred<File>

exists

• exists(): boolean

• Returns boolean

existsAsync

• existsAsync(): PromiseLike<boolean>

• Returns PromiseLike<boolean>

read

• read<T>(mix?): T

• Type Parameters

  • T = string | Buffer

  Parameters

  • Optional mix: IOperationOptions

  Returns T

readAsync

• readAsync<T>(mix?): Promise<T>

• Type Parameters

  • T = string | Buffer

  Parameters

  • Optional mix: IOperationOptions

  Returns Promise<T>

readRange

• readRange<T>(position, length, mix?): T

• Type Parameters

  • T = string

  Parameters

  • position: number

  • length: number

  • Optional mix: IOperationOptions

  Returns T

readRangeAsync

• readRangeAsync<T>(position, length, mix?): IDeferred<T>

• Type Parameters

  • T = string

  Parameters

  • position: number

  • length: number

  • Optional mix: IOperationOptions

  Returns IDeferred<T>

remove

• remove(): boolean

• Returns boolean

removeAsync

• removeAsync(): Promise<boolean>

• Returns Promise<boolean>

rename

• rename(fileName): boolean

• Parameters

  • fileName: string

  Returns boolean

renameAsync

• renameAsync(filename): IDeferred<boolean>

• Parameters

  • filename: any

  Returns IDeferred<boolean>

replace

• replace(a, b, setts?): string

• Parameters

  • a: string | RegExp

  • b: string | ((substring, ...args) => string)

  • Optional setts: any

  Returns string

replaceAsync

• replaceAsync(a, b, setts?): Promise<string>

• Parameters

  • a: string | RegExp

  • b: string | ((substring, ...args) => string)

  • Optional setts: any

  Returns Promise<string>

stats

• stats(): Stats

• Returns Stats

unwatch

• unwatch(callback?): void

• Parameters

  • Optional callback: any

  Returns void

watch

• watch(callback): void

• Parameters

  • callback: ((path?) => any)

    • • (path?): any

      • Parameters

        • Optional path: string

        Returns any

  Returns void

write

• write<T>(content, mix?): this

• Type Parameters

  • T = any

  Parameters

  • content: T

  • Optional mix: IOperationOptions

  Returns this

writeAsync

• writeAsync<T>(content, mix?): Promise<File>

• Type Parameters

  • T = any

  Parameters

  • content: T

  • Optional mix: IOperationOptions

  Returns Promise<File>

Static append

• append(path, str): boolean

• Parameters

  • path: string

  • str: string

  Returns boolean

Static appendAsync

• appendAsync(path, str): IDeferred<boolean>

• Parameters

  • path: string

  • str: string

  Returns IDeferred<boolean>

Static clearCache

• clearCache(mix?): void

• Parameters

  • Optional mix: any

  Returns void

Static copyTo

• copyTo(path, target, opts?): File

• Parameters

  • path: string

  • target: string

  • Optional opts: IFileCopyOpts

  Returns File

Static copyToAsync

• copyToAsync(path, target, opts?): IDeferred<File>

• Parameters

  • path: string

  • target: string

  • Optional opts: IFileCopyOpts

  Returns IDeferred<File>

Static disableCache

• disableCache(): void

• Returns void

Static enableCache

• enableCache(): void

• Returns void

Static exists

• exists(path): boolean

• Parameters

  • path: string

  Returns boolean

Static existsAsync

• existsAsync(path): PromiseLike<boolean>

• Parameters

  • path: string | class_Uri

  Returns PromiseLike<boolean>

Static getFactory

• getFactory(): FileFactory

• Returns FileFactory

Static getHookHandler

• getHookHandler(): FileHooks

• Returns FileHooks

Static getTransports

• getTransports(): {
      [protocol: string]: ITransport;
  }

• Returns {
      [protocol: string]: ITransport;
  }

  • [protocol: string]: ITransport

Static processHooks

• processHooks(method, file, config, onComplete?): Promise<void>

• Parameters

  • method: any

  • file: any

  • config: any

  • Optional onComplete: any

  Returns Promise<void>

Static read

• read<T>(path, mix?): T

• Type Parameters

  • T = string | Buffer

  Parameters

  • path: string

  • Optional mix: IFileSettings & IOperationOptions

  Returns T

Static readAsync

• readAsync<T>(path, mix?): Promise<T>

• Type Parameters

  • T = string | Buffer

  Parameters

  • path: string

  • Optional mix: IFileSettings & IOperationOptions

  Returns Promise<T>

Static readRange

• readRange<T>(path, position, length, mix?): T

• Type Parameters

  • T = string

  Parameters

  • path: string

  • position: number

  • length: number

  • Optional mix: IOperationOptions

  Returns T

Static readRangeAsync

• readRangeAsync<T>(path, position, length, mix?): IDeferred<T>

• Type Parameters

  • T = string

  Parameters

  • path: string

  • position: number

  • length: number

  • Optional mix: IOperationOptions

  Returns IDeferred<T>

Static registerExtensions

• registerExtensions(extensions, shouldCleanPrevious?, settings?): void

• Parameters

  • extensions: any

  • shouldCleanPrevious: boolean = false

  • settings: any = null

  Returns void

Static registerFactory

• registerFactory(factory): void

• Parameters

  • factory: FileFactory

  Returns void

Static registerHookHandler

• registerHookHandler(hook): void

• Parameters

  • hook: FileHooks

  Returns void

Static registerTransport

• registerTransport(protocol, transport): void

• Parameters

  • protocol: string

  • transport: ITransport

  Returns void

Static remove

• remove(path): boolean

• Parameters

  • path: string

  Returns boolean

Static removeAsync

• removeAsync(path): Promise<boolean>

• Parameters

  • path: string

  Returns Promise<boolean>

Static rename

• rename(path, fileName): boolean

• Parameters

  • path: string

  • fileName: string

  Returns boolean

Static renameAsync

• renameAsync(path, fileName): IDeferred<boolean>

• Parameters

  • path: string

  • fileName: string

  Returns IDeferred<boolean>

Static replace

• replace(path, a, b, setts?): string

• Parameters

  • path: string

  • a: string | RegExp

  • b: string | ((substring, ...args) => string)

  • Optional setts: any

  Returns string

Static replaceAsync

• replaceAsync(path, a, b, setts?): Promise<string>

• Parameters

  • path: string

  • a: string | RegExp

  • b: string | ((substring, ...args) => string)

  • Optional setts: any

  Returns Promise<string>

Static setMiddlewares

• setMiddlewares(extensions, settings?): void

• Parameters

  • extensions: any

  • settings: any = null

  Returns void

Static setTransports

• setTransports(repository): void

• Parameters

  • repository: any

  Returns void

Static stats

• stats(path): Stats

• Parameters

  • path: string

  Returns Stats

Static unwatch

• unwatch(path, callback?): void

• Parameters

  • path: string

  • Optional callback: any

  Returns void

Static watch

• watch(path, callback): void

• Parameters

  • path: string

  • callback: ((path?) => any)

    • • (path?): any

      • Parameters

        • Optional path: string

        Returns any

  Returns void

Static write

• write<T>(path, content, mix?): File

• Type Parameters

  • T = any

  Parameters

  • path: string

  • content: T

  • Optional mix: IFileSettings & IOperationOptions

  Returns File

Static writeAsync

• writeAsync<T>(path, content, mix?): Promise<File>

• Type Parameters

  • T = any

  Parameters

  • path: string

  • content: T

  • Optional mix: IFileSettings & IOperationOptions

  Returns Promise<File>