Class File

Hierarchy

files.Dir
- File

Index

Constructors

constructor

Properties

name path

Constructors

constructor

new File(...path): files.File
Parameters
- Rest ...path: string[]
Returns files.File
Overrides Dir.constructor
- Defined in gfsl/types/index.d.ts:55

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 gfsl/types/index.d.ts:48

chmod

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

Returns void
- Defined in gfsl/types/index.d.ts:92

copyTo

copyTo(dir): void
Copies this file or directory to a set location
Parameters
- dir: files.File
Returns void
Inherited from Dir.copyTo
- Defined in gfsl/types/index.d.ts:32

dir

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

Returns files.Dir
- Defined in gfsl/types/index.d.ts:57

download

download(url, chk?, opt?): Promise<files.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: files.File
      
      Returns void
  - Optional signal?: AbortSignal
Returns Promise<files.File>
this object to allow for chaining
- Defined in gfsl/types/index.d.ts:83

exists

exists(): boolean
Checks if this file exists

Returns boolean
Inherited from Dir.exists
- Defined in gfsl/types/index.d.ts:36

getDir

getDir(..._file): files.Dir
Gets a new directory relative to this directory
Parameters
- Rest ..._file: string[]
Returns files.Dir
Inherited from Dir.getDir
- Defined in gfsl/types/index.d.ts:26

getFile

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

getHash

getHash(algorithm?): string
gets the hash of this file
Parameters
- Optional algorithm: string
Returns string
Overrides Dir.getHash
- Defined in gfsl/types/index.d.ts:71

getName

getName(): string
Gets the name of this file

Returns string
Overrides Dir.getName
- Defined in gfsl/types/index.d.ts:65

getSize

getSize(): number
gets the size of this file

Returns number
Overrides Dir.getSize
- Defined in gfsl/types/index.d.ts:73

isExecutable

isExecutable(): Promise<boolean>
Returns Promise<boolean>
- Defined in gfsl/types/index.d.ts:104

isLink

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

Returns boolean
Inherited from Dir.isLink
- Defined in gfsl/types/index.d.ts:22

isRelative

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

Returns boolean
Inherited from Dir.isRelative
- Defined in gfsl/types/index.d.ts:8

javaPath

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

Returns string
Overrides Dir.javaPath
- Defined in gfsl/types/index.d.ts:69

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.File
Returns void
Inherited from Dir.linkFrom
- Defined in gfsl/types/index.d.ts:16

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.File
Returns void
Inherited from Dir.linkTo
- Defined in gfsl/types/index.d.ts:14

load

load<T>(def, serializer?): T & files.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
- Optional serializer: ((raw) => T)
  - - (raw): T
    - Parameters
      
      raw: T
      
      Returns T
Returns T & files.WrappedObj
- Defined in gfsl/types/index.d.ts:96

ls

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

Returns (files.Dir | files.File)[]
Inherited from Dir.ls
- Defined in gfsl/types/index.d.ts:42

mkdir

mkdir(): files.File
Double checks if the directory exists

Returns files.File
Inherited from Dir.mkdir
- Defined in gfsl/types/index.d.ts:12

moveTo

moveTo(file): files.File
Moves this file or directory to a set location
Parameters
- file: files.File
Returns files.File
Inherited from Dir.moveTo
- Defined in gfsl/types/index.d.ts:34

read

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

Returns string
- Defined in gfsl/types/index.d.ts:61

readRaw

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

Returns Buffer
- Defined in gfsl/types/index.d.ts:59

rm

rm(): files.File
Removes this file or directory

Returns files.File
Inherited from Dir.rm
- Defined in gfsl/types/index.d.ts:30

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 gfsl/types/index.d.ts:46

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 gfsl/types/index.d.ts:44

sysPath

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

Returns string
Overrides Dir.sysPath
- Defined in gfsl/types/index.d.ts:67

toBase64

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

Returns string
- Defined in gfsl/types/index.d.ts:63

toJSON

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

toString

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

Returns string
Inherited from Dir.toString
- Defined in gfsl/types/index.d.ts:24

unzip

unzip(path, opt?): Promise<void>
Parameters
- path: files.Dir
- Optional opt: {
      exclude?: string[];
      include?: string[];
      zipDir?: files.Dir;
  }
  - Optional exclude?: string[]
  - Optional include?: string[]
  - Optional zipDir?: files.Dir
Returns Promise<void>
- Defined in gfsl/types/index.d.ts:99

wrap

wrap<T>(obj): T & files.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 & files.WrappedObj
- Defined in gfsl/types/index.d.ts:98

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 gfsl/types/index.d.ts:94

`Static` tmpdir

tmpdir(): files.Dir
Returns the system temp directory

Returns files.Dir
Inherited from Dir.tmpdir
- Defined in gfsl/types/index.d.ts:18

Class File

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Rest ...path: string[]

Returns files.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: files.File

Returns void

dir

Returns files.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: files.File

Returns void

Optional signal?: AbortSignal

Returns Promise<files.File>

exists

Returns boolean

getDir

Parameters

Rest ..._file: string[]

Returns files.Dir

getFile

Parameters

Rest ..._file: string[]

Returns files.File

getHash

Parameters

Optional algorithm: string

Returns string

getName

Returns string

getSize

Returns number

isExecutable

Returns Promise<boolean>

isLink

Returns boolean

isRelative

Returns boolean

javaPath

Returns string

linkFrom

Parameters

path: string | string[] | files.File

Returns void

linkTo

Parameters

dest: string | string[] | files.File

Returns void

load

Type Parameters

T

`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

`Rest` ..._file: string[]

`Rest` ..._file: string[]

`Optional` algorithm: string

`Optional` serializer: ((raw) => T)

`Optional` opt: {
exclude?: string[];
include?: string[];
zipDir?: files.Dir;
}

`Optional` exclude?: string[]

`Optional` include?: string[]

`Optional` zipDir?: files.Dir

`Static` tmpdir