JsonLinesStream
OCP App SDK / JsonLinesStream
Class: JsonLinesStream<T>
Defined in: src/util/JsonLinesStream.ts:18
Superclass of stream file reader with the main
logic involve in processing a file line by line
Extends
FileStream
<T
,Options
>
Type Parameters
T
T
Constructors
Constructor
new JsonLinesStream<
T
>(streamBuilder
,rowProcessor
,options
):JsonLinesStream
<T
>
Defined in: src/util/JsonLinesStream.ts:55
Parameters
streamBuilder
rowProcessor
options
Options
= {}
Returns
JsonLinesStream
<T
>
Overrides
Accessors
isFinished
Get Signature
get isFinished():
boolean
Defined in: src/util/FileStream.ts:44
Returns
boolean
Inherited from
Methods
fastforward()
fastforward(
target
):Promise
<null
|string
>
Defined in: src/util/FileStream.ts:48
Parameters
target
string
Returns
Promise
<null
| string
>
Inherited from
processSome()
processSome():
Promise
<null
|string
>
Defined in: src/util/FileStream.ts:53
Returns
Promise
<null
| string
>
Inherited from
fromStream()
static
fromStream<T
>(stream
,processor
,options
):JsonLinesStream
<T
>
Defined in: src/util/JsonLinesStream.ts:25
Build a JsonLinesStream from an existing ReadableStream.
Type Parameters
T
T
Parameters
stream
ReadableStream
source stream for the JsonLines data
processor
the row processor
options
Options
= {}
options to provide the JsonLinesParser Options
Returns
JsonLinesStream
<T
>
fromUrl()
static
fromUrl<T
>(url
,processor
,options
):JsonLinesStream
<T
>
Defined in: src/util/JsonLinesStream.ts:39
Build a JsonLinesStream that reads from a web resource.
Type Parameters
T
T
Parameters
url
string
source url for the JsonLines data
processor
the row processor
options
Options
= {}
options to provide the JsonLinesParser Options
Returns
JsonLinesStream
<T
>
Updated 3 days ago