Class File

Hierarchy

Dir
- File

Index

Constructors

constructor

Properties

name path

Constructors

constructor

new File(...path): File
Parameters
- Rest ...path: string[]
Returns File
Overrides Dir.constructor
- Defined in modules/objects/files.ts:219

Properties

name

name: string

path

path: string[]

Methods

chkSelf

chkSelf(chk?): boolean
Returns true if the file is in missmatch.
Parameters
- Optional chk: {
  sha1?: string | string[];
  size?: number;
  }
  - Optional sha1?: string | string[]
  - Optional size?: number
Returns boolean
Inherited from Dir.chkSelf
- Defined in modules/objects/files.ts:209

chmod

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

Returns void
- Defined in modules/objects/files.ts:310

copyTo

copyTo(dir): void
Copies this file or directory to a set location
Parameters
- dir: File
Returns void
Inherited from Dir.copyTo
- Defined in modules/objects/files.ts:157

dir

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

Returns Dir
- Defined in modules/objects/files.ts:224

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 modules/objects/files.ts:274

exists

exists(): boolean
Checks if this file exists

Returns boolean
Inherited from Dir.exists
- Defined in modules/objects/files.ts:166

expand

expand(json, zipDir): Promise<void>
Parameters
- json: Partial<DownloadableFile>
- zipDir: Dir
Returns Promise<void>
- Defined in modules/objects/files.ts:375

extract

extract(path, files, zipDir?): Promise<void>
Similar to unzip, but uses a whitelist approach
Parameters
- path: Dir
- files: string[]
- Optional zipDir: Dir
Returns Promise<void>
- Defined in modules/objects/files.ts:412

getDir

getDir(..._file): Dir
Gets a new directory relative to this directory
Parameters
- Rest ..._file: string[]
Returns Dir
Inherited from Dir.getDir
- Defined in modules/objects/files.ts:144

getFile

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

getHash

getHash(algorithm?): string
gets the hash of this file
Parameters
- algorithm: string = "sha1"
Returns string
Overrides Dir.getHash
- Defined in modules/objects/files.ts:252

getName

getName(): string
Gets the name of this file

Returns string
Overrides Dir.getName
- Defined in modules/objects/files.ts:240

getSize

getSize(): number
gets the size of this file

Returns number
Overrides Dir.getSize
- Defined in modules/objects/files.ts:258

isExecutable

isExecutable(): Promise<boolean>
Returns Promise<boolean>
- Defined in modules/objects/files.ts:430

isLink

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

Returns boolean
Inherited from Dir.isLink
- Defined in modules/objects/files.ts:136

isRelative

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

Returns boolean
Inherited from Dir.isRelative
- Defined in modules/objects/files.ts:90

javaPath

javaPath(): string
Returns string
Overrides Dir.javaPath
- Defined in modules/objects/files.ts:248

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 modules/objects/files.ts:117

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 modules/objects/files.ts:106

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 modules/objects/files.ts:320

ls

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

Returns (Dir | File)[]
Inherited from Dir.ls
- Defined in modules/objects/files.ts:178

mkdir

mkdir(): File
Double checks if the directory exists

Returns File
Inherited from Dir.mkdir
- Defined in modules/objects/files.ts:101

moveTo

moveTo(file): File
Moves this file or directory to a set location
Parameters
- file: File
Returns File
Inherited from Dir.moveTo
- Defined in modules/objects/files.ts:161

read

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

Returns string
- Defined in modules/objects/files.ts:232

readRaw

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

Returns Buffer
- Defined in modules/objects/files.ts:228

rm

rm(): File
Removes this file or directory

Returns File
Inherited from Dir.rm
- Defined in modules/objects/files.ts:152

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 modules/objects/files.ts:194

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 modules/objects/files.ts:189

sysPath

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

Returns string
Overrides Dir.sysPath
- Defined in modules/objects/files.ts:244

toBase64

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

Returns string
- Defined in modules/objects/files.ts:236

toDownloadable

toDownloadable(url, key?, chk?, opt?): DownloadableFile
Parameters
- url: string
- Optional key: string
- Optional chk: {
  sha1?: string | string[];
  size?: number;
  }
  - Optional sha1?: string | string[]
  - Optional size?: number
- Optional opt: {
      executable?: string | boolean;
      unzip?: {
          exclude?: string[];
          file: Dir;
      };
  }
  - Optional executable?: string | boolean
  - Optional unzip?: {
    exclude?: string[];
    file: Dir;
    }
    - Optional exclude?: string[]
    - file: Dir
Returns DownloadableFile
- Defined in modules/objects/files.ts:333

toJSON

toJSON<T>(): T
Reads a set file and returns a json representation of that object
Type Parameters
- T
Returns T
- Defined in modules/objects/files.ts:262

toString

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

Returns string
Inherited from Dir.toString
- Defined in modules/objects/files.ts:140

unzip

unzip(path, exclude?, zipDir?): Promise<void>
Similar to extract, but uses a blacklist approach
Parameters
- path: Dir
- Optional exclude: string[]
- Optional zipDir: Dir
Returns Promise<void>
- Defined in modules/objects/files.ts:394

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 modules/objects/files.ts:327

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 modules/objects/files.ts:315

`Static` check

check(json): number
0 Full redownload 1 unzip only 2 fine
Parameters
- json: Partial<DownloadableFile>
Returns number
- Defined in modules/objects/files.ts:367

`Static` process

process(json, zipDir): Promise<void>
Parameters
- json: DownloadableFile
- zipDir: Dir
Returns Promise<void>
- Defined in modules/objects/files.ts:385

`Static` tmpdir

tmpdir(): Dir
Returns the system temp directory

Returns Dir
Inherited from Dir.tmpdir
- Defined in modules/objects/files.ts:128

Class File

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Rest ...path: string[]

Returns File

Properties

name

path

Methods

chkSelf

Parameters

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

Optional sha1?: string | string[]

Optional size?: number

Returns boolean

chmod

Returns void

copyTo

Parameters

dir: File

Returns void

dir

Returns Dir

download

Parameters

url: string

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

Optional sha1?: string | string[]

Optional size?: number

Optional opt: { noRetry?: true; onReDownload?: ((file) => void); signal?: AbortSignal; }

Optional noRetry?: true

Optional onReDownload?: ((file) => void)

Parameters

file: File

Returns void

Optional signal?: AbortSignal

Returns Promise<File>

exists

Returns boolean

expand

Parameters

json: Partial<DownloadableFile>

zipDir: Dir

Returns Promise<void>

extract

Parameters

path: Dir

files: string[]

Optional zipDir: Dir

Returns Promise<void>

getDir

Parameters

Rest ..._file: string[]

Returns Dir

getFile

Parameters

Rest ..._file: string[]

Returns File

getHash

Parameters

algorithm: string = "sha1"

Returns string

getName

Returns string

getSize

Returns number

isExecutable

Returns Promise<boolean>

isLink

Returns boolean

isRelative

Returns boolean

javaPath

Returns string

`Rest` ...path: string[]

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

`Optional` sha1?: string | string[]

`Optional` size?: number

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

`Optional` sha1?: string | string[]

`Optional` size?: number

`Optional` opt: {
noRetry?: true;
onReDownload?: ((file) => void);
signal?: AbortSignal;
}

`Optional` noRetry?: true

`Optional` onReDownload?: ((file) => void)

`Optional` signal?: AbortSignal

`Optional` zipDir: Dir

`Rest` ..._file: string[]

`Rest` ..._file: string[]

`Optional` key: string

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

`Optional` sha1?: string | string[]

`Optional` size?: number

`Optional` opt: {
executable?: string | boolean;
unzip?: {
exclude?: string[];
file: Dir;
};
}

`Optional` executable?: string | boolean

`Optional` unzip?: {
exclude?: string[];
file: Dir;
}

`Optional` exclude?: string[]

`Optional` exclude: string[]

`Optional` zipDir: Dir