Class File

Hierarchy

Dir
- File

Index

Constructors

Properties

Constructors

constructor

new File(...path): File
Parameters
- Rest ...path: string[]
Returns File
Overrides Dir.constructor
- Defined in index.ts:180

Properties

name

name: string

path

path: string[]

Methods

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
Inherited from Dir.chkSelf
- Defined in index.ts:169

chmod

chmod(): void
Sets the execution bit on a set file, used on Linux and Mac systems

Returns void
- Defined in index.ts:267

copyTo

copyTo(dir): void
Copies this file or directory to a set location
Parameters
- dir: File
Returns void
Inherited from Dir.copyTo
- Defined in index.ts:117

dir

dir(): Dir
Gets the directory of a set file

Returns Dir
- Defined in index.ts:185

download

download(url, chk?, opt?): Promise<File>
Downloads a set file using fetch internally
Parameters
- url: string
  
  The url of the file you want to download
- Optional chk: {
  sha1?: string | string[];
  size?: number;
  }
  
  The file check
  - Optional sha1?: string | string[]
  - Optional size?: number
- Optional opt: {
      noRetry?: true;
      onReDownload?: ((file) => void);
      signal?: AbortSignal;
  }
  - Optional noRetry?: true
  - Optional onReDownload?: ((file) => void)
    - (file): void
      
      Parameters
      
      file: File
      
      Returns void
  - Optional signal?: AbortSignal
Returns Promise<File>
this object to allow for chaining
- Defined in index.ts:235

exists

exists(): boolean
Checks if this file exists

Returns boolean
Inherited from Dir.exists
- Defined in index.ts:126

getDir

getDir(..._file): Dir
Gets a new directory relative to this directory
Parameters
- Rest ..._file: string[]
Returns Dir
Inherited from Dir.getDir
- Defined in index.ts:104

getFile

getFile(..._file): File
Gets a new file relative to this directory
Parameters
- Rest ..._file: string[]
Returns File
Inherited from Dir.getFile
- Defined in index.ts:108

getHash

getHash(algorithm?): string
gets the hash of this file
Parameters
- algorithm: string = "sha1"
Returns string
Overrides Dir.getHash
- Defined in index.ts:213

getName

getName(): string
Gets the name of this file

Returns string
Overrides Dir.getName
- Defined in index.ts:201

getSize

getSize(): number
gets the size of this file

Returns number
Overrides Dir.getSize
- Defined in index.ts:219

isExecutable

isExecutable(): Promise<boolean>
Returns Promise<boolean>
- Defined in index.ts:317

isLink

isLink(): boolean
Checks if a directory is a symbolic link

Returns boolean
Inherited from Dir.isLink
- Defined in index.ts:96

isRelative

isRelative(): boolean
Checks if a directory or file is in a relative or absolute state

Returns boolean
Inherited from Dir.isRelative
- Defined in index.ts:50

javaPath

javaPath(): string
Returns a java path off this directory or file

Returns string
Overrides Dir.javaPath
- Defined in index.ts:209

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[] | File
Returns void
Inherited from Dir.linkFrom
- Defined in index.ts:77

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[] | File
Returns void
Inherited from Dir.linkTo
- Defined in index.ts:66

load

load<T>(def, serializer?): T & WrappedObj
Loads a json object from the file system and adds some shortcut functions to make it easier to save.
Type Parameters
- T
Parameters
- def: T
- serializer: ((raw) => T) = ...
  - - (raw): T
    - Parameters
      
      raw: T
      
      Returns T
Returns T & WrappedObj
- Defined in index.ts:277

ls

ls(): (Dir | File)[]
Lists a set directory's contents

Returns (Dir | File)[]
Inherited from Dir.ls
- Defined in index.ts:138

mkdir

mkdir(): File
Double checks if the directory exists

Returns File
Inherited from Dir.mkdir
- Defined in index.ts:61

moveTo

moveTo(file): File
Moves this file or directory to a set location
Parameters
- file: File
Returns File
Inherited from Dir.moveTo
- Defined in index.ts:121

read

read(): string
Reads a file and returns it as a string

Returns string
- Defined in index.ts:193

readRaw

readRaw(): Buffer
Reads a file and returns the raw array buffer

Returns Buffer
- Defined in index.ts:189

rm

rm(): File
Removes this file or directory

Returns File
Inherited from Dir.rm
- Defined in index.ts:112

sha1

sha1(expected): boolean
Checks if an expected hash matches with this object. (@see getHash)
Parameters
- expected: string | string[]
Returns boolean
Inherited from Dir.sha1
- Defined in index.ts:154

size

size(expected): boolean
Checks if the size value given matches with this object. (@see getSize)
Parameters
- expected: number
Returns boolean
Inherited from Dir.size
- Defined in index.ts:149

sysPath

sysPath(): string
Return the system path of a file

Returns string
Overrides Dir.sysPath
- Defined in index.ts:205

toBase64

toBase64(): string
Returns a base64 representation of the file

Returns string
- Defined in index.ts:197

toJSON

toJSON<T>(): T
Reads a set file and returns a json representation of that object
Type Parameters
- T
Returns T
- Defined in index.ts:223

toString

toString(): string
Does the same as the sysPath function

Returns string
Inherited from Dir.toString
- Defined in index.ts:100

unzip

unzip(path, opt?): Promise<void>
Parameters
- path: Dir
- opt: {
      exclude?: string[];
      include?: string[];
      zipDir?: Dir;
  } = {}
  - Optional exclude?: string[]
  - Optional include?: string[]
  - Optional zipDir?: Dir
Returns Promise<void>
- Defined in index.ts:291

wrap

wrap<T>(obj): T & WrappedObj
Turns an object into a wrappedObj. Essentially this just adds functions to make it easier to save.
Type Parameters
- T
Parameters
- obj: T
Returns T & WrappedObj
- Defined in index.ts:284

write

write(data): void
Writes data to file. Automatically converts JSON objects to parsable strings before saving them
Parameters
- data: string | object | ArrayBuffer
Returns void
- Defined in index.ts:272

`Static` tmpdir

tmpdir(): Dir
Returns the system temp directory

Returns Dir
Inherited from Dir.tmpdir
- Defined in index.ts:88

Generated using TypeDoc