Class Directory

constructor

• new Directory(directory): Directory

• Parameters

  • directory: string | class_Uri | Directory

  Returns Directory

files

uri

Static symlink

copyTo

• copyTo(target, options?): IDeferred<void>

• Parameters

  • target: string

  • options: {
        verbose?: boolean;
    } = ...

    • Optional verbose?: boolean

  Returns IDeferred<void>

copyToAsync

• copyToAsync(target, options?): IDeferred<void>

• Parameters

  • target: string

  • options: {
        verbose?: boolean;
    } = ...

    • Optional verbose?: boolean

  Returns IDeferred<void>

ensure

• ensure(): this

• Returns this

ensureAsync

• ensureAsync(): IDeferred<Directory>

• Returns IDeferred<Directory>

exists

• exists(): boolean

• Returns boolean

existsAsync

• existsAsync(): IDeferred<boolean>

• Returns IDeferred<boolean>

getName

• getName(): string

• Returns string

read

• read(pattern?, exclude?): (File | Directory)[]

• Parameters

  • Optional pattern: string | RegExp | (string | RegExp)[]

  • Optional exclude: string | RegExp | (string | RegExp)[]

  Returns (File | Directory)[]

readAsync

• readAsync(pattern?, exclude?): IDeferred<(File | Directory)[]>

• Parameters

  • Optional pattern: string | RegExp | (string | RegExp)[]

  • Optional exclude: string | RegExp | (string | RegExp)[]

  Returns IDeferred<(File | Directory)[]>

readFiles

• readFiles(pattern?, exclude?): File[]

• Parameters

  • Optional pattern: string | RegExp | (string | RegExp)[]

  • Optional exclude: string | RegExp | (string | RegExp)[]

  Returns File[]

readFilesAsync

• readFilesAsync(pattern?, exclude?): IDeferred<File[]>

• Parameters

  • Optional pattern: string | RegExp | (string | RegExp)[]

  • Optional exclude: string | RegExp | (string | RegExp)[]

  Returns IDeferred<File[]>

remove

• remove(): void

• Returns void

removeAsync

• removeAsync(): IDeferred<any>

• Returns IDeferred<any>

rename

• rename(name): void

• Parameters

  • name: string

  Returns void

renameAsync

• renameAsync(name): IDeferred<any>

• Parameters

  • name: string

  Returns IDeferred<any>

unwatch

• unwatch(callback?): void

• Parameters

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

    • • (path): any

      • Parameters

        • path: string

        Returns any

  Returns void

watch

• watch(callback): void

• Parameters

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

    • • (path?): any

      • Parameters

        • Optional path: string

        Returns any

  Returns void

Static copyTo

• copyTo(path, target, options?): IDeferred<void>

• Parameters

  • path: string

  • target: string

  • options: {
        verbose?: boolean;
    } = ...

    • Optional verbose?: boolean

  Returns IDeferred<void>

Static copyToAsync

• copyToAsync(path, target, options?): IDeferred<void>

• Parameters

  • path: string

  • target: string

  • options: {
        verbose?: boolean;
    } = ...

    • Optional verbose?: boolean

  Returns IDeferred<void>

Static ensure

• ensure(path): Directory

• Parameters

  • path: string

  Returns Directory

Static ensureAsync

• ensureAsync(path): IDeferred<Directory>

• Parameters

  • path: string

  Returns IDeferred<Directory>

Static exists

• exists(path): boolean

• Parameters

  • path: string

  Returns boolean

Static existsAsync

• existsAsync(path): IDeferred<boolean>

• Parameters

  • path: string

  Returns IDeferred<boolean>

Static read

• read(path, pattern?, exclude?): (File | Directory)[]

• Parameters

  • path: string

  • Optional pattern: string | RegExp | (string | RegExp)[]

  • Optional exclude: string | RegExp | (string | RegExp)[]

  Returns (File | Directory)[]

Static readAsync

• readAsync(path, pattern?, exclude?): IDeferred<(File | Directory)[]>

• Parameters

  • path: string

  • Optional pattern: string | RegExp | (string | RegExp)[]

  • Optional exclude: string | RegExp | (string | RegExp)[]

  Returns IDeferred<(File | Directory)[]>

Static readFiles

• readFiles(path, pattern?, exclude?): File[]

• Parameters

  • path: string

  • Optional pattern: string | RegExp | (string | RegExp)[]

  • Optional exclude: string | RegExp | (string | RegExp)[]

  Returns File[]

Static readFilesAsync

• readFilesAsync(path, pattern?, exclude?): IDeferred<File[]>

• Parameters

  • path: string

  • Optional pattern: string | RegExp | (string | RegExp)[]

  • Optional exclude: string | RegExp | (string | RegExp)[]

  Returns IDeferred<File[]>

Static remove

• remove(path): void

• Parameters

  • path: string

  Returns void

Static removeAsync

• removeAsync(path): IDeferred<void>

• Parameters

  • path: string

  Returns IDeferred<void>

Static rename

• rename(path, name): void

• Parameters

  • path: string

  • name: string

  Returns void

Static renameAsync

• renameAsync(path, name): IDeferred<any>

• Parameters

  • path: string

  • name: string

  Returns IDeferred<any>

Static unwatch

• unwatch(path, callback?): void

• Parameters

  • path: string

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

    • • (path?): any

      • Parameters

        • Optional path: string

        Returns 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