File | @easy-node/server

Hierarchy

FileSystem
- File

Index

Constructors

constructor

Properties

Constructors

constructor

new File(path: string): File

Overrides FileSystem.__constructor
- Defined in src/lib/FileSystem/File.ts:3
Parameters
- path: string
Returns File

Properties

path

path: string

Static ACCESS_FILE_OK

ACCESS_FILE_OK: number = fs.constants.F_OK

表明调用进程可以读取文件

Static ACCESS_READ_OK

ACCESS_READ_OK: number = fs.constants.R_OK

表明文件对调用进程可见

Static ACCESS_WRITE_OK

ACCESS_WRITE_OK: number = fs.constants.W_OK

表明调用进程可以写入文件。

Static ACCESS_X_OK

ACCESS_X_OK: number = fs.constants.X_OK

表明调用进程可以执行文件。在 Windows 上无效（表现得像 fs.constants.F_OK）。

Methods

access

access(mode?: number): Promise<void>

Inherited from FileSystem.access
- Defined in src/lib/FileSystem/FileSystem.ts:12
测试对文件/目录的权限异步

Parameters
- Default value mode: number = FileSystem.ACCESS_FILE_OK
Returns Promise<void>

accessSync

accessSync(mode?: number): void

Inherited from FileSystem.accessSync
- Defined in src/lib/FileSystem/FileSystem.ts:19
测试对文件/目录的权限同步

Parameters
- Default value mode: number = FileSystem.ACCESS_FILE_OK
Returns void

appendAsBuffer

appendAsBuffer(data: Buffer): Promise<void>

- Defined in src/lib/FileSystem/File.ts:73
以buffer形式追加同步

Parameters
- data: Buffer
Returns Promise<void>

appendAsBufferSync

appendAsBufferSync(data: Buffer): void

- Defined in src/lib/FileSystem/File.ts:80
以buffer形式追加异步

Parameters
- data: Buffer
Returns void

appendAsString

appendAsString(data: string, options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }): Promise<void>

- Defined in src/lib/FileSystem/File.ts:57
以文本形式追加异步

Parameters
- data: string
- options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }
  - Optional encoding?: BufferEncoding
  - Optional flag?: string | number
  - Optional mode?: string | number
Returns Promise<void>

appendAsStringSync

appendAsStringSync(data: string, options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }): void

- Defined in src/lib/FileSystem/File.ts:65
以文本形式追加同步

Parameters
- data: string
- options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }
  - Optional encoding?: BufferEncoding
  - Optional flag?: string | number
  - Optional mode?: string | number
Returns void

copy

copy(path: string): Promise<File>

- Defined in src/lib/FileSystem/File.ts:11
复制文件异步

Parameters
- path: string
Returns Promise<File>

copySync

copySync(path: string): File

- Defined in src/lib/FileSystem/File.ts:18
复制文件同步

Parameters
- path: string
Returns File

readAsBuffer

readAsBuffer(): Promise<Buffer>

- Defined in src/lib/FileSystem/File.ts:110
以Buffer的形式读取文件异步

Returns Promise<Buffer>

readAsBufferSync

readAsBufferSync(): Buffer

- Defined in src/lib/FileSystem/File.ts:116
以Buffer的形式读取文件同步

Returns Buffer

readAsStream

readAsStream(options?: { autoClose?: undefined | false | true; emitClose?: undefined | false | true; encoding?: undefined | string; end?: undefined | number; fd?: undefined | number; flags?: undefined | string; highWaterMark?: undefined | number; mode?: undefined | number; start?: undefined | number }): ReadStream

- Defined in src/lib/FileSystem/File.ts:124
以流的形式读取

Parameters
- Default value options: { autoClose?: undefined | false | true; emitClose?: undefined | false | true; encoding?: undefined | string; end?: undefined | number; fd?: undefined | number; flags?: undefined | string; highWaterMark?: undefined | number; mode?: undefined | number; start?: undefined | number } = {}
  - Optional autoClose?: undefined | false | true
  - Optional emitClose?: undefined | false | true
    
    default
    
    false
  - Optional encoding?: undefined | string
  - Optional end?: undefined | number
  - Optional fd?: undefined | number
  - Optional flags?: undefined | string
  - Optional highWaterMark?: undefined | number
  - Optional mode?: undefined | number
  - Optional start?: undefined | number
Returns ReadStream

readAsString

readAsString(encoding?: BufferEncoding, flag?: string | number): Promise<string>

- Defined in src/lib/FileSystem/File.ts:89
以文本形式读取文件异步

Parameters
- Default value encoding: BufferEncoding = "utf8"
- Optional flag: string | number
Returns Promise<string>

readAsStringSync

readAsStringSync(encoding?: BufferEncoding, flag?: undefined | string): string

- Defined in src/lib/FileSystem/File.ts:100
以文本形式读取文件同步

Parameters
- Default value encoding: BufferEncoding = "utf8"
- Optional flag: undefined | string
Returns string

remove

remove(): Promise<void>

- Defined in src/lib/FileSystem/File.ts:161
删除文件异步

Returns Promise<void>

removeSync

removeSync(): void

- Defined in src/lib/FileSystem/File.ts:168
删除文件同步

Returns void

rename

rename(newPath: string): Promise<void>

Inherited from FileSystem.rename
- Defined in src/lib/FileSystem/FileSystem.ts:41
修改文件/目录名称异步

Parameters
- newPath: string
Returns Promise<void>

renameSync

renameSync(newPath: string): void

Inherited from FileSystem.renameSync
- Defined in src/lib/FileSystem/FileSystem.ts:50
修改文件/目录名称同步

Parameters
- newPath: string
Returns void

stat

stat(): Promise<Stats>

Inherited from FileSystem.stat
- Defined in src/lib/FileSystem/FileSystem.ts:26
获取文件/目录状态信息异步

Returns Promise<Stats>

statSync

statSync(): Stats

Inherited from FileSystem.statSync
- Defined in src/lib/FileSystem/FileSystem.ts:33
获取文件/目录状态信息同步

Returns Stats

watch

watch(options: { encoding?: BufferEncoding | null; persistent?: undefined | false | true; recursive?: undefined | false | true }, listener?: undefined | ((event: string, filename: string) => any)): FSWatcher

Inherited from FileSystem.watch
- Defined in src/lib/FileSystem/FileSystem.ts:60
监听文件/目录变化

Parameters
- options: { encoding?: BufferEncoding | null; persistent?: undefined | false | true; recursive?: undefined | false | true }
  - Optional encoding?: BufferEncoding | null
  - Optional persistent?: undefined | false | true
  - Optional recursive?: undefined | false | true
- Optional listener: undefined | ((event: string, filename: string) => any)
Returns FSWatcher

writeAsBuffer

writeAsBuffer(data: Buffer): Promise<void>

- Defined in src/lib/FileSystem/File.ts:44
以buffer形式写入

Parameters
- data: Buffer
Returns Promise<void>

writeAsBufferSync

writeAsBufferSync(data: Buffer): void

- Defined in src/lib/FileSystem/File.ts:47
Parameters
- data: Buffer
Returns void

writeAsStream

writeAsStream(options?: { autoClose?: undefined | false | true; emitClose?: undefined | false | true; encoding?: undefined | string; fd?: undefined | number; flags?: undefined | string; highWaterMark?: undefined | number; mode?: undefined | number; start?: undefined | number }): WriteStream

- Defined in src/lib/FileSystem/File.ts:145
以流的形式写入

Parameters
- Default value options: { autoClose?: undefined | false | true; emitClose?: undefined | false | true; encoding?: undefined | string; fd?: undefined | number; flags?: undefined | string; highWaterMark?: undefined | number; mode?: undefined | number; start?: undefined | number } = {}
  - Optional autoClose?: undefined | false | true
  - Optional emitClose?: undefined | false | true
  - Optional encoding?: undefined | string
  - Optional fd?: undefined | number
  - Optional flags?: undefined | string
  - Optional highWaterMark?: undefined | number
  - Optional mode?: undefined | number
  - Optional start?: undefined | number
Returns WriteStream

writeAsString

writeAsString(data: string, options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }): Promise<void>

- Defined in src/lib/FileSystem/File.ts:28
以文本形式写入异步

Parameters
- data: string
- options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }
  - Optional encoding?: BufferEncoding
  - Optional flag?: string | number
  - Optional mode?: string | number
Returns Promise<void>

writeAsStringSync

writeAsStringSync(data: string, options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }): void

- Defined in src/lib/FileSystem/File.ts:36
以文本形式写入同步

Parameters
- data: string
- options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }
  - Optional encoding?: BufferEncoding
  - Optional flag?: string | number
  - Optional mode?: string | number
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

path: string

Returns File

Properties

path

Static ACCESS_FILE_OK

Static ACCESS_READ_OK

Static ACCESS_WRITE_OK

Static ACCESS_X_OK

Methods

access

Parameters

Default value mode: number = FileSystem.ACCESS_FILE_OK

Returns Promise<void>

accessSync

Parameters

Default value mode: number = FileSystem.ACCESS_FILE_OK

Returns void

appendAsBuffer

Parameters

data: Buffer

Returns Promise<void>

appendAsBufferSync

Parameters

data: Buffer

Returns void

appendAsString

Parameters

data: string

options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }

Optional encoding?: BufferEncoding

Optional flag?: string | number

Optional mode?: string | number

Returns Promise<void>

appendAsStringSync

Parameters

data: string

options: { encoding?: BufferEncoding; flag?: string | number; mode?: string | number }

Optional encoding?: BufferEncoding

Optional flag?: string | number

Optional mode?: string | number

Returns void

copy

Parameters

path: string

Returns Promise<File>

copySync

Parameters

path: string

Returns File

readAsBuffer

Returns Promise<Buffer>

readAsBufferSync

Returns Buffer

readAsStream

Parameters

Optional autoClose?: undefined | false | true

Optional emitClose?: undefined | false | true

Optional encoding?: undefined | string

Optional end?: undefined | number

Optional fd?: undefined | number

Optional flags?: undefined | string

Optional highWaterMark?: undefined | number

Optional mode?: undefined | number

Optional start?: undefined | number

Returns ReadStream

readAsString

Parameters

Default value encoding: BufferEncoding = "utf8"

Optional flag: string | number

Returns Promise<string>

readAsStringSync

Parameters