Class FileInputStream

File input stream for Node.js.

Hierarchy

ReadableStream<Uint8Array>
- FileInputStream

Implements

AsyncDisposable

Index

Constructors

Methods

[asyncDispose] close

Constructors

constructor

new FileInputStream(filename: string, chunkSize?: number): FileInputStream
Creates a new file input stream reading to the given file.
Parameters
- filename: string
  The name of the file to read.
- chunkSize: number = 8192
  The size of the chunks to read from the file.
Returns FileInputStream
Overrides ReadableStream<Uint8Array>.constructor
- Defined in streams/FileInputStream.ts:21

Methods

[asyncDispose]

"[asyncDispose]"(): PromiseLike<void>
Returns PromiseLike<void>
Inherit Doc
Implementation of AsyncDisposable.[asyncDispose]
- Defined in streams/FileInputStream.ts:60

close

close(): Promise<void>
Closes the stream.

Returns Promise<void>
- Defined in streams/FileInputStream.ts:52