OCP App SDK / FileStream

FileStream<T, O>

Superclass of stream file reader with the main
logic involve in processing a file line by line

Type parameters

• T
• O

Hierarchy

• CsvStream
• JsonLinesStream

Index

Constructors

• constructor

Accessors

• isFinished

Methods

• fastforward
• processSome

Constructors

constructor()

Signature

new FileStream<T, O>(
  streamBuilder: FileReadableStreamBuilder,
  rowProcessor: FileRowProcessor<T>,
  parser: Function,
  options: O = ...): FileStream<T, O>;

Type parameters

• T
• O

Parameters

Returns

FileStream<T, O>

Defined in: src/util/FileStream.ts:37

Accessors

isFinished

Signature

isFinished(): boolean;

Returns

boolean

Defined in: src/util/FileStream.ts:44

Defined in: src/util/FileStream.ts:44

Methods

fastforward()

Signature

fastforward(target: string): Promise<null | string>;

Parameters

Returns

Promise<null | string>

Defined in: src/util/FileStream.ts:48

processSome()

Signature

processSome(): Promise<null | string>;

Returns

Promise<null | string>

Defined in: src/util/FileStream.ts:53