Function readAsync

readAsync(fd, buffer?, offset?, length?, position?): Promise<ReadResult>
Read data from a file.
Parameters
- fd: number
  
  file descriptor
- Optional buffer: ArrayBufferView
  
  output buffer [Buffer.alloc(16384)]
- Optional offset: number
  
  buffer offset [0]
- Optional length: number
  
  read length [buffer.length - offset]
- Optional position: ReadPosition
  
  file position [null ⇒ current]
Returns Promise<ReadResult>
read status {bytesRead, buffer}
- Defined in src/index.ts:250
readAsync<B>(fd, options?): Promise<ReadResult<B>>
Read data from a file.
Type Parameters
- B extends ArrayBufferView = ArrayBufferView
Parameters
- fd: number
  
  file descriptor
- Optional options: ReadAsyncOptions<B>
  
  read options {buffer, offset, length, position}
Returns Promise<ReadResult<B>>
read status {bytesRead, buffer}
- Defined in src/index.ts:258

Generated using TypeDoc