Class File`Abstract`

Hierarchy (view full)

File
- PortFile
- PreloadFile

Index

Constructors

Properties

Constructors

constructor

new File(): File
Returns File

Properties

`Readonly` `Abstract` path

path: string

The path to the file

`Abstract` position

position: number

Get the current file position.

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
- Defined in src/file.ts:179

[dispose]

[dispose](): void
Returns void
- Defined in src/file.ts:183

`Abstract` _setType

_setType(type): Promise<void>
Internal
Set the file type
Parameters
- type: FileType
Returns Promise<void>
- Defined in src/file.ts:313

`Abstract` _setTypeSync

_setTypeSync(type): void
Internal
Set the file type
Parameters
- type: FileType
Returns void
- Defined in src/file.ts:319

`Abstract` chmod

chmod(mode): Promise<void>
Asynchronous fchmod.
Parameters
- mode: number
Returns Promise<void>
- Defined in src/file.ts:292

`Abstract` chmodSync

chmodSync(mode): void
Synchronous fchmod.
Parameters
- mode: number
Returns void
- Defined in src/file.ts:297

`Abstract` chown

chown(uid, gid): Promise<void>
Asynchronous chown.
Parameters
- uid: number
- gid: number
Returns Promise<void>
- Defined in src/file.ts:282

`Abstract` chownSync

chownSync(uid, gid): void
Synchronous chown.
Parameters
- uid: number
- gid: number
Returns void
- Defined in src/file.ts:287

`Abstract` close

close(): Promise<void>
Asynchronous close.

Returns Promise<void>
- Defined in src/file.ts:172

`Abstract` closeSync

closeSync(): void
Synchronous close.

Returns void
- Defined in src/file.ts:177

datasync

datasync(): Promise<void>
Asynchronous datasync.

Default implementation maps to sync.

Returns Promise<void>
- Defined in src/file.ts:266

datasyncSync

datasyncSync(): void
Synchronous datasync.

Default implementation maps to syncSync.

Returns void
- Defined in src/file.ts:275

`Abstract` read

read<TBuffer>(buffer, offset?, length?, position?): Promise<FileReadResult<TBuffer>>
Read data from the file.
Type Parameters
- TBuffer extends ArrayBufferView
Parameters
- buffer: TBuffer
  The buffer that the data will be written to.
- Optional offset: number
  The offset within the buffer where writing will start.
- Optional length: number
  An integer specifying the number of bytes to read.
- Optional position: number
  An integer specifying where to begin reading from in the file. If position is null, data will be read from the current file position.
Returns Promise<FileReadResult<TBuffer>>
Promise resolving to the new length of the buffer
- Defined in src/file.ts:248

`Abstract` readSync

readSync(buffer, offset?, length?, position?): number
Read data from the file.
Parameters
- buffer: ArrayBufferView
  The buffer that the data will be written to.
- Optional offset: number
  The offset within the buffer where writing will start.
- Optional length: number
  An integer specifying the number of bytes to read.
- Optional position: number
  An integer specifying where to begin reading from in the file. If position is null, data will be read from the current file position.
Returns number
- Defined in src/file.ts:259

`Abstract` stat

stat(): Promise<Stats>
Asynchronous stat.

Returns Promise<Stats>
- Defined in src/file.ts:162

`Abstract` statSync

statSync(): Stats
Synchronous stat.

Returns Stats
- Defined in src/file.ts:167

`Abstract` sync

sync(): Promise<void>
Asynchronous sync.

Returns Promise<void>
- Defined in src/file.ts:200

`Abstract` syncSync

syncSync(): void
Synchronous sync.

Returns void
- Defined in src/file.ts:205

`Abstract` truncate

truncate(len): Promise<void>
Asynchronous truncate.
Parameters
- len: number
Returns Promise<void>
- Defined in src/file.ts:190

`Abstract` truncateSync

truncateSync(len): void
Synchronous truncate.
Parameters
- len: number
Returns void
- Defined in src/file.ts:195

`Abstract` utimes

utimes(atime, mtime): Promise<void>
Change the file timestamps of the file.
Parameters
- atime: Date
- mtime: Date
Returns Promise<void>
- Defined in src/file.ts:302

`Abstract` utimesSync

utimesSync(atime, mtime): void
Change the file timestamps of the file.
Parameters
- atime: Date
- mtime: Date
Returns void
- Defined in src/file.ts:307

`Abstract` write

write(buffer, offset?, length?, position?): Promise<number>
Write buffer to the file. Note that it is unsafe to use fs.write multiple times on the same file without waiting for the callback.
Parameters
- buffer: Uint8Array
  Uint8Array containing the data to write to the file.
- Optional offset: number
  Offset in the buffer to start reading data from.
- Optional length: number
  The amount of bytes to write to the file.
- Optional position: number
  Offset from the beginning of the file where this data should be written. If position is null, the data will be written at the current position.
Returns Promise<number>
Promise resolving to the new length of the buffer
- Defined in src/file.ts:220

`Abstract` writeSync

writeSync(buffer, offset?, length?, position?): number
Write buffer to the file. Note that it is unsafe to use fs.writeSync multiple times on the same file without waiting for it to return.
Parameters
- buffer: Uint8Array
  Uint8Array containing the data to write to the file.
- Optional offset: number
  Offset in the buffer to start reading data from.
- Optional length: number
  The amount of bytes to write to the file.
- Optional position: number
  Offset from the beginning of the file where this data should be written. If position is null, the data will be written at the current position.
Returns number
- Defined in src/file.ts:234