Interface File

Hierarchy

File

Implemented by

Index

Methods

Methods

chmod

chmod(mode: number, cb: BFSOneArgCallback): void

- Defined in core/file.ts:115
Optional: Asynchronous fchmod.

Parameters
- mode: number
- cb: BFSOneArgCallback
Returns void

chmodSync

chmodSync(mode: number): void

- Defined in core/file.ts:119
Optional: Synchronous fchmod.

Parameters
- mode: number
Returns void

chown

chown(uid: number, gid: number, cb: BFSOneArgCallback): void

- Defined in core/file.ts:107
Optional: Asynchronous chown.

Parameters
- uid: number
- gid: number
- cb: BFSOneArgCallback
Returns void

chownSync

chownSync(uid: number, gid: number): void

- Defined in core/file.ts:111
Optional: Synchronous chown.

Parameters
- uid: number
- gid: number
Returns void

close

close(cb: BFSOneArgCallback): void

- Defined in core/file.ts:21
Core: Asynchronous close.

Parameters
- cb: BFSOneArgCallback
Returns void

closeSync

closeSync(): void

- Defined in core/file.ts:25
Core: Synchronous close.

Returns void

datasync

datasync(cb: BFSOneArgCallback): void

- Defined in core/file.ts:97
Supplementary: Asynchronous datasync.

Default implementation maps to sync.

Parameters
- cb: BFSOneArgCallback
Returns void

datasyncSync

datasyncSync(): void

- Defined in core/file.ts:103
Supplementary: Synchronous datasync.

Default implementation maps to syncSync.

Returns void

getPos

getPos(): number | undefined

- Defined in core/file.ts:9
Core: Get the current file position.

Returns number | undefined

read

read(buffer: Buffer, offset: number, length: number, position: number | null, cb: BFSThreeArgCallback<number, Buffer>): void

- Defined in core/file.ts:81
Core: Read data from the file.

Parameters
- buffer: Buffer
  
  The buffer that the data will be written to.
- offset: number
  
  The offset within the buffer where writing will start.
- length: number
  
  An integer specifying the number of bytes to read.
- position: number | null
  
  An integer specifying where to begin reading from in the file. If position is null, data will be read from the current file position.
- cb: BFSThreeArgCallback<number, Buffer>
  
  The number is the number of bytes read
Returns void

readSync

readSync(buffer: Buffer, offset: number, length: number, position: number): number

- Defined in core/file.ts:91
Core: Read data from the file.

Parameters
- buffer: Buffer
  
  The buffer that the data will be written to.
- offset: number
  
  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

stat

stat(cb: BFSCallback<Stats>): void

- Defined in core/file.ts:13
Core: Asynchronous stat.

Parameters
- cb: BFSCallback<Stats>
Returns void

statSync

statSync(): Stats

- Defined in core/file.ts:17
Core: Synchronous stat.

Returns Stats

sync

sync(cb: BFSOneArgCallback): void

- Defined in core/file.ts:37
Core: Asynchronous sync.

Parameters
- cb: BFSOneArgCallback
Returns void

syncSync

syncSync(): void

- Defined in core/file.ts:41
Core: Synchronous sync.

Returns void

truncate

truncate(len: number, cb: BFSOneArgCallback): void

- Defined in core/file.ts:29
Core: Asynchronous truncate.

Parameters
- len: number
- cb: BFSOneArgCallback
Returns void

truncateSync

truncateSync(len: number): void

- Defined in core/file.ts:33
Core: Synchronous truncate.

Parameters
- len: number
Returns void

utimes

utimes(atime: Date, mtime: Date, cb: BFSOneArgCallback): void

- Defined in core/file.ts:123
Optional: Change the file timestamps of the file.

Parameters
- atime: Date
- mtime: Date
- cb: BFSOneArgCallback
Returns void

utimesSync

utimesSync(atime: Date, mtime: Date): void

- Defined in core/file.ts:127
Optional: Change the file timestamps of the file.

Parameters
- atime: Date
- mtime: Date
Returns void

write

write(buffer: Buffer, offset: number, length: number, position: number | null, cb: BFSThreeArgCallback<number, Buffer>): void

- Defined in core/file.ts:55
Core: 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: Buffer
  
  Buffer containing the data to write to the file.
- offset: number
  
  Offset in the buffer to start reading data from.
- length: number
  
  The amount of bytes to write to the file.
- position: number | null
  
  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.
- cb: BFSThreeArgCallback<number, Buffer>
  
  The number specifies the number of bytes written into the file.
Returns void

writeSync

writeSync(buffer: Buffer, offset: number, length: number, position: number | null): number

- Defined in core/file.ts:68
Core: 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: Buffer
  
  Buffer containing the data to write to the file.
- offset: number
  
  Offset in the buffer to start reading data from.
- length: number
  
  The amount of bytes to write to the file.
- position: number | null
  
  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

Generated using TypeDoc