Class Dir

constructor

• new Dir(...path): files.Dir

• Parameters

  • Rest ...path: string[]

  Returns files.Dir

path

chkSelf

• chkSelf(chk?): boolean

• Returns true if the file matches what is expected.

  Parameters

  • Optional chk: {
        sha1?: string | string[];
        size?: number;
    }

    • Optional sha1?: string | string[]

    • Optional size?: number

  Returns boolean

copyTo

• copyTo(dir): void

• Copies this file or directory to a set location

  Parameters

  • dir: files.Dir

  Returns void

exists

• exists(): boolean

• Checks if this file exists

  Returns boolean

getDir

• getDir(..._file): files.Dir

• Gets a new directory relative to this directory

  Parameters

  • Rest ..._file: string[]

  Returns files.Dir

getFile

• getFile(..._file): files.File

• Gets a new file relative to this directory

  Parameters

  • Rest ..._file: string[]

  Returns files.File

getHash

• getHash(algorithm?): string

• Returns a hash of all the sub files in a folder

  Parameters

  • Optional algorithm: string

  Returns string

getName

• getName(): string

• Gets the name of this directory

  Returns string

getSize

• getSize(): number

• Returns the amount of files in a directory

  Returns number

isLink

• isLink(): boolean

• Checks if a directory is a symbolic link

  Returns boolean

isRelative

• isRelative(): boolean

• Checks if a directory or file is in a relative or absolute state

  Returns boolean

javaPath

• javaPath(): string

• Returns a java path off this directory or file

  Returns string

linkFrom

• linkFrom(path): void

• Creates a system link to a set file or directory using this file or folder as the the placeholder for the link (similar to linkTo)

  Parameters

  • path: string | string[] | files.Dir

  Returns void

linkTo

• linkTo(dest): void

• Creates a system link to this file and puts the link at the destination file that was provided as input (similar to linkFrom)

  Parameters

  • dest: string | string[] | files.Dir

  Returns void

ls

• ls(): (files.Dir | files.File)[]

• Lists a set directory's contents

  Returns (files.Dir | files.File)[]

mkdir

• mkdir(): files.Dir

• Double checks if the directory exists

  Returns files.Dir

moveTo

• moveTo(file): files.Dir

• Moves this file or directory to a set location

  Parameters

  • file: files.Dir

  Returns files.Dir

rm

• rm(): files.Dir

• Removes this file or directory

  Returns files.Dir

sha1

• sha1(expected): boolean

• Checks if an expected hash matches with this object. (@see getHash)

  Parameters

  • expected: string | string[]

  Returns boolean

size

• size(expected): boolean

• Checks if the size value given matches with this object. (@see getSize)

  Parameters

  • expected: number

  Returns boolean

sysPath

• sysPath(): string

• Return the system path of a directory

  Returns string

toString

• toString(): string

• Does the same as the sysPath function

  Returns string

Static tmpdir

• tmpdir(): files.Dir

• Returns the system temp directory

  Returns files.Dir