FileStream
15 min
OCP App SDKOCP App SDK
OCP App SDKOCP App SDK / FileStream
Class: abstract FileStream<T, O>
Defined in: src/util/FileStream.ts:29
Superclass of stream file reader with the main logic involve in processing a file line by line
Extended by
- `CsvStream`CsvStream
- `JsonLinesStream`JsonLinesStream
Type Parameters
T
T
O
O
Constructors
Constructor
new FileStream<T, O>(streamBuilder, rowProcessor, parser, options): FileStream<T, O>
Defined in: src/util/FileStream.ts:37
Parameters
streamBuilder
`FileReadableStreamBuilder`FileReadableStreamBuilder
rowProcessor
`FileRowProcessor`FileRowProcessor<T>
parser
(args) => Transform
options
O = ...
Returns
FileStream<T, O>
Accessors
isFinished
Get Signature
get isFinished(): boolean
Defined in: src/util/FileStream.ts:44
Returns
boolean
Methods
fastforward()
fastforward(target): Promise<null | string>
Defined in: src/util/FileStream.ts:48
Parameters
target
string
Returns
Promise<null | string>
processSome()
processSome(): Promise<null | string>
Defined in: src/util/FileStream.ts:53
Returns
Promise<null | string>