Class File

Hierarchy

Entry
- File

Index

Constructors

Properties

Accessors

Methods

append delete dir exists open read readable readJson readStream stat toString touch utimes writable write writeJson writeStream from

Constructors

constructor

new File(path): File
Parameters
- path: string
Returns File
Overrides Entry.constructor
- Defined in file.ts:138

Properties

`Readonly`name

name: string

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in file.ts:227

Methods

append

append(data, options?): Promise<boolean>
Parameters
- data: any
- Optionaloptions: Encoding | AppendOptions
Returns Promise<boolean>
- Defined in file.ts:182

delete

delete(): Promise<boolean>
Returns Promise<boolean>
Inherited from Entry.delete
- Defined in file.ts:89

dir

dir(): Dir
Returns Dir
- Defined in file.ts:142

exists

exists(): Promise<boolean>
Returns Promise<boolean>
Inherited from Entry.exists
- Defined in file.ts:50

open

open(flags, mode?): Promise<FileHandle>
Parameters
- flags: string | number
- Optionalmode: null | string | number
Returns Promise<FileHandle>
- Defined in file.ts:154

read

read(): Promise<Buffer>
Returns Promise<Buffer>
- Defined in file.ts:161
read(options): Promise<string>
Parameters
- options: Encoding
Returns Promise<string>
- Defined in file.ts:162
read(options?): Promise<string | Buffer>
Parameters
- Optionaloptions: Encoding | ReadOptions
Returns Promise<string | Buffer>
- Defined in file.ts:163

readable

readable(): Promise<boolean>
Returns Promise<boolean>
Inherited from Entry.readable
- Defined in file.ts:63

readJson

readJson(options?, reviver?): Promise<unknown>
Parameters
- Optionaloptions: Encoding | ReadJsonOptions
- Optionalreviver: ((key: any, value: any) => any)
  - - (key, value): any
    - Parameters
      key: any
      value: any
      Returns any
Returns Promise<unknown>
- Defined in file.ts:199

readStream

readStream(options?): ReadStream
Parameters
- Optionaloptions: Encoding | ReadOptions
Returns ReadStream
- Defined in file.ts:146

stat

stat(): Promise<Stats>
Returns Promise<Stats>
Inherited from Entry.stat
- Defined in file.ts:39

toString

toString(): string
Returns string
Inherited from Entry.toString
- Defined in file.ts:102

touch

touch(options?): Promise<boolean>
Parameters
- Optionaloptions: TouchOptions
Returns Promise<boolean>
- Defined in file.ts:222

utimes

utimes(atime, mtime): Promise<void>
Parameters
- atime: string | number | Date
- mtime: string | number | Date
Returns Promise<void>
Inherited from Entry.utimes
- Defined in file.ts:43

writable

writable(): Promise<boolean>
Returns Promise<boolean>
Inherited from Entry.writable
- Defined in file.ts:76

write

write(data, options?): Promise<boolean>
Parameters
- data: any
- Optionaloptions: Encoding | WriteOptions
Returns Promise<boolean>
- Defined in file.ts:168

writeJson

writeJson(data, options?, replacer?, space?): Promise<void>
Parameters
- data: any
- Optionaloptions: Encoding | WriteJsonOptions
- Optionalreplacer: ((key: string, value: any) => any)
  - - (key, value): any
    - Parameters
      key: string
      value: any
      Returns any
- Optionalspace: string | number
Returns Promise<void>
- Defined in file.ts:209

writeStream

writeStream(options?): WriteStream
Parameters
- Optionaloptions: Encoding | WriteOptions
Returns WriteStream
- Defined in file.ts:150

`Static`from

from(name): File
Parameters
- name: string | File
Returns File
- Defined in file.ts:130