FileHandle | @mists/temp

Enhancement of the fs.promises.FileHandle, which is a wrapper for a numeric file descriptor. Instances of FileHandle are distinct from numeric file descriptors in that they provide an object oriented API for working with files.

Read more about FileHandles at NodeJs.org

Hierarchy

FileHandle

Implements

FileHandle

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

Private constructor

new FileHandle(filename: string, filehandle: FileHandle, fd: number): FileHandle

- Defined in index.ts:20
Constructor of the FileHandle. Private. Use create() method instead.

Parameters
- filename: string
  
  Name of created file
- filehandle: FileHandle
  
  NodeJs stored fs.promises.FileHandle
- fd: number
  
  See fs.promises.FileHandle.fd
Returns FileHandle

Properties

fd

fd: number

See fs.promises.FileHandle.fd

Private filehandle

filehandle: FileHandle

NodeJs stored fs.promises.FileHandle

Private filename

filename: string

Name of created file

Accessors

fileHanle

get fileHanle(): FileHandle

- Defined in index.ts:51
Returns the default Nodejs fs.promises.FileHandle instance.

Returns FileHandle

name

get name(): string

- Defined in index.ts:58
Returns the name of the created/opened file.

Returns string

Methods

appendFile

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

- Defined in index.ts:65
See fs.promises.FileHandle.appendFile()

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

chmod

chmod(mode: string | number): Promise<void>

- Defined in index.ts:75
See fs.promises.FileHandle.chmod()

Parameters
- mode: string | number
Returns Promise<void>

chown

chown(uid: number, gid: number): Promise<void>

- Defined in index.ts:82
See fs.promises.FileHandle.chown()

Parameters
- uid: number
- gid: number
Returns Promise<void>

close

close(): Promise<void>

- Defined in index.ts:89
See fs.promises.FileHandle.close()

Returns Promise<void>

datasync

datasync(): Promise<void>

- Defined in index.ts:96
See fs.promises.FileHandle.datasync()

Returns Promise<void>

read

read<TBuffer>(buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<{ buffer: TBuffer; bytesRead: number }>

- Defined in index.ts:103
See fs.promises.FileHandle.read()

Type parameters
- TBuffer: Uint8Array
Parameters
- buffer: TBuffer
- Optional offset: number | null
- Optional length: number | null
- Optional position: number | null
Returns Promise<{ buffer: TBuffer; bytesRead: number }>

readFile

readFile(options?: { encoding?: null | BufferEncoding; flag?: string | number } | null): Promise<Buffer>
readFile(options: { encoding: BufferEncoding; flag?: string | number } | BufferEncoding): Promise<string>

- Defined in index.ts:115
See fs.promises.FileHandle.readFile()

Parameters
- Optional options: { encoding?: null | BufferEncoding; flag?: string | number } | null
Returns Promise<Buffer>
- Defined in index.ts:116
Parameters
- options: { encoding: BufferEncoding; flag?: string | number } | BufferEncoding
Returns Promise<string>

readv

readv(buffers: NodeJS.ArrayBufferView[], position?: undefined | number): Promise<ReadVResult>

- Defined in index.ts:124
See fs.promises.FileHandle.readv()

Parameters
- buffers: NodeJS.ArrayBufferView[]
- Optional position: undefined | number
Returns Promise<ReadVResult>

stat

stat(): Promise<Stats>

- Defined in index.ts:131
See fs.promises.FileHandle.stat()

Returns Promise<Stats>

sync

sync(): Promise<void>

- Defined in index.ts:138
See fs.promises.FileHandle.sync()

Returns Promise<void>

truncate

truncate(len?: undefined | number): Promise<void>

- Defined in index.ts:145
See fs.promises.FileHandle.truncate()

Parameters
- Optional len: undefined | number
Returns Promise<void>

utimes

utimes(atime: string | number | Date, mtime: string | number | Date): Promise<void>

- Defined in index.ts:152
See fs.promises.FileHandle.utimes()

Parameters
- atime: string | number | Date
- mtime: string | number | Date
Returns Promise<void>

write

write(data: any, ...args: any): Promise<{ buffer: string; bytesWritten: number }>

- Defined in index.ts:161
See fs.promises.FileHandle.write()

Parameters
- data: any
- Rest ...args: any
Returns Promise<{ buffer: string; bytesWritten: number }>

writeFile

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

- Defined in index.ts:171
See fs.promises.FileHandle.writeFile()

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

writev

writev(buffers: NodeJS.ArrayBufferView[], position?: undefined | number): Promise<WriteVResult>

- Defined in index.ts:181
See fs.promises.FileHandle.read()

Parameters
- buffers: NodeJS.ArrayBufferView[]
- Optional position: undefined | number
Returns Promise<WriteVResult>

Static create

create(filename: string): Promise<FileHandle>

- Defined in index.ts:42
Asynchronous file create that returns a Promise that, when resolved, yields a FileHandle object.

File will be created and opened with 'w+' flag (see support of file system flags) and 0o666 mode.
```
const fh = FileHandle.create('/tmp/new-file.txt')
```
Parameters
- filename: string
  
  Name of the file to create.
Returns Promise<FileHandle>

Generated using TypeDoc

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

filename: string

filehandle: FileHandle

fd: number

Returns FileHandle

Properties

fd

Private filehandle

Private filename

Accessors

fileHanle

Returns FileHandle

name

Returns string

Methods

appendFile

Parameters

data: any

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

Returns Promise<void>

chmod

Parameters

mode: string | number

Returns Promise<void>

chown

Parameters

uid: number

gid: number

Returns Promise<void>

close

Returns Promise<void>

datasync

Returns Promise<void>

read

Type parameters

TBuffer: Uint8Array

Parameters

buffer: TBuffer

Optional offset: number | null

Optional length: number | null

Optional position: number | null

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

readFile

Parameters

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

Returns Promise<Buffer>

Parameters

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

Returns Promise<string>

readv

Parameters

buffers: NodeJS.ArrayBufferView[]

Optional position: undefined | number

Returns Promise<ReadVResult>

stat

Returns Promise<Stats>

sync

Returns Promise<void>

truncate

Parameters

Optional len: undefined | number

Returns Promise<void>

utimes

Parameters

atime: string | number | Date

mtime: string | number | Date

Returns Promise<void>

write

Parameters

data: any

Rest ...args: any