Class LazyFile<FS>

An implementation of File that uses the FS

Type Parameters

FS extends FileSystem

Hierarchy (View Summary)

File<FS>
- LazyFile

Index

Constructors

constructor

new LazyFile<FS extends FileSystem>(
    fs: FS,
    path: string,
    flag: string,
    stats: StatsLike<number>,
): LazyFile<FS>
Creates a file with path and, optionally, the given contents. Note that, if contents is specified, it will be mutated by the file.
Type Parameters
- FS extends FileSystem
Parameters
- fs: FS
- path: string
- flag: string
- stats: StatsLike<number>
Returns LazyFile<FS>
Overrides File.constructor
- Defined in src/file.ts:618

Properties

`Protected` `Optional`_buffer

_buffer?: Uint8Array<ArrayBufferLike>

`Protected`_position

_position: number = 0

Current position

`Protected`closed

closed: boolean = false

Whether the file is open or closed

`Protected`dirty

dirty: boolean = false

Whether the file has changes which have not been written to the FS

`Readonly`flag

flag: string

`Internal`fs

fs: FS

The file system that created the file

`Readonly`path

path: string

`Readonly`stats

stats: StatsLike<number>

Accessors

position

get position(): number
Get the current file position.

We emulate the following bug mentioned in the Node documentation:

On Linux, positional writes don't work when the file is opened in append mode. The kernel ignores the position argument and always appends the data to the end of the file.

Returns number
The current file position.
Overrides File.position
- Defined in src/file.ts:596
set position(value: number): void
Get the current file position.
Parameters
- value: number
Returns void
Overrides File.position
- Defined in src/file.ts:600

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
Inherited from File.[asyncDispose]
- Defined in src/file.ts:149

[dispose]

"[dispose]"(): void
Returns void
Inherited from File.[dispose]
- Defined in src/file.ts:153

chmod

chmod(mode: number): Promise<void>
Parameters
- mode: number
Returns Promise<void>
Overrides File.chmod
- Defined in src/file.ts:823

chmodSync

chmodSync(mode: number): void
Parameters
- mode: number
Returns void
Overrides File.chmodSync
- Defined in src/file.ts:830

chown

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

chownSync

chownSync(uid: number, gid: number): void
Parameters
- uid: number
- gid: number
Returns void
Overrides File.chownSync
- Defined in src/file.ts:844

close

close(): Promise<void>
Returns Promise<void>
Overrides File.close
- Defined in src/file.ts:647

closeSync

closeSync(): void
Returns void
Overrides File.closeSync
- Defined in src/file.ts:653

datasync

datasync(): Promise<void>
Default implementation maps to sync.

Returns Promise<void>
Inherited from File.datasync
- Defined in src/file.ts:213

datasyncSync

datasyncSync(): void
Default implementation maps to syncSync.

Returns void
Inherited from File.datasyncSync
- Defined in src/file.ts:220

`Protected`dispose

dispose(force?: boolean): void
Cleans up. This will not sync the file data to the FS
Parameters
- Optionalforce: boolean
Returns void
- Defined in src/file.ts:662

`Protected`prepareRead

prepareRead(length: number, position: number): number
Computes position information for reading
Parameters
- length: number
- position: number
Returns number
- Defined in src/file.ts:763

`Protected`prepareWrite

prepareWrite(
    buffer: Uint8Array<ArrayBufferLike>,
    offset: number,
    length: number,
    position: number,
): Uint8Array<ArrayBufferLike>
Parameters
- buffer: Uint8Array<ArrayBufferLike>
- offset: number
- length: number
- position: number
Returns Uint8Array<ArrayBufferLike>
- Defined in src/file.ts:706

read

read<TBuffer extends ArrayBufferView<ArrayBufferLike>>(
    buffer: TBuffer,
    offset?: number,
    length?: number,
    position?: number,
): Promise<{ buffer: TBuffer; bytesRead: number }>
Read data from the file.
Type Parameters
- TBuffer extends ArrayBufferView<ArrayBufferLike>
Parameters
- buffer: TBuffer
  The buffer that the data will be written to.
- offset: number = 0
  The offset within the buffer where writing will start.
- length: number = ...
  An integer specifying the number of bytes to read.
- position: number = ...
  An integer specifying where to begin reading from in the file. If position is unset, data will be read from the current file position.
Returns Promise<{ buffer: TBuffer; bytesRead: number }>
Overrides File.read
- Defined in src/file.ts:788

readSync

readSync(
    buffer: ArrayBufferView<ArrayBufferLike>,
    offset?: number,
    length?: number,
    position?: number,
): number
Read data from the file.
Parameters
- buffer: ArrayBufferView<ArrayBufferLike>
  The buffer that the data will be written to.
- offset: number = 0
  The offset within the buffer where writing will start.
- length: number = ...
  An integer specifying the number of bytes to read.
- 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
number of bytes written
Overrides File.readSync
- Defined in src/file.ts:810

stat

stat(): Promise<Stats>
Returns Promise<Stats>
Overrides File.stat
- Defined in src/file.ts:670

statSync

statSync(): Stats
Returns Stats
Overrides File.statSync
- Defined in src/file.ts:676

sync

sync(): Promise<void>
Returns Promise<void>
Overrides File.sync
- Defined in src/file.ts:629

syncSync

syncSync(): void
Returns void
Overrides File.syncSync
- Defined in src/file.ts:638

truncate

truncate(length: number): Promise<void>
Parameters
- length: number
Returns Promise<void>
Overrides File.truncate
- Defined in src/file.ts:682

truncateSync

truncateSync(length: number): void
Parameters
- length: number
Returns void
Overrides File.truncateSync
- Defined in src/file.ts:694

utimes

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

utimesSync

utimesSync(atime: number, mtime: number): void
Change the file timestamps of the file.
Parameters
- atime: number
- mtime: number
Returns void
Overrides File.utimesSync
- Defined in src/file.ts:860

write

write(
    buffer: Uint8Array<ArrayBufferLike>,
    offset?: number,
    length?: number,
    position?: number,
): Promise<number>
Write buffer to the file.
Parameters
- buffer: Uint8Array<ArrayBufferLike>
  Uint8Array containing the data to write to the file.
- offset: number = 0
  Offset in the buffer to start reading data from.
- length: number = ...
  The amount of bytes to write to the file.
- 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>
Overrides File.write
- Defined in src/file.ts:732

writeSync

writeSync(
    buffer: Uint8Array<ArrayBufferLike>,
    offset?: number,
    length?: number,
    position?: number,
): number
Write buffer to the file.
Parameters
- buffer: Uint8Array<ArrayBufferLike>
  Uint8Array containing the data to write to the file.
- offset: number = 0
  Offset in the buffer to start reading data from.
- length: number = ...
  The amount of bytes to write to the file.
- 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
bytes written
Overrides File.writeSync
- Defined in src/file.ts:753

Class LazyFile<FS>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LazyFile<FS>

Properties

Protected Optional_buffer

Protected_position

Protectedclosed

Protecteddirty

Readonlyflag

Internalfs

Readonlypath

Readonlystats

Accessors

position

Returns number

Parameters

Returns void

Methods

[asyncDispose]

Returns Promise<void>

[dispose]

Returns void

chmod

Parameters

Returns Promise<void>

chmodSync

Parameters

Returns void

chown

Parameters

Returns Promise<void>

chownSync

Parameters

Returns void

close

Returns Promise<void>

closeSync

Returns void

datasync

Returns Promise<void>

datasyncSync

Returns void

Protecteddispose

Parameters

Returns void

ProtectedprepareRead

Parameters

Returns number

ProtectedprepareWrite

Parameters

Returns Uint8Array<ArrayBufferLike>

read

Type Parameters

Parameters

Returns Promise<{ buffer: TBuffer; bytesRead: number }>

readSync

Parameters

Returns number

stat

Returns Promise<Stats>

statSync

Returns Stats

sync

Returns Promise<void>

syncSync

Returns void

truncate

Parameters

Returns Promise<void>

truncateSync

`Protected` `Optional`_buffer

`Protected`_position

`Protected`closed

`Protected`dirty

`Readonly`flag

`Internal`fs

`Readonly`path

`Readonly`stats

`Protected`dispose

`Protected`prepareRead

`Protected`prepareWrite