Search
Preparing search index...
The search index is not available
ngl
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
StringStreamer
Class StringStreamer
Provides a streamer interface for a string. Used in unit tests
Hierarchy
Streamer
StringStreamer
Index
Constructors
constructor
Properties
__partial
Line
__pointer
binary
chunk
Size
compressed
data
json
newline
src
xml
Accessors
__src
Name
type
Methods
_chunk
_read
as
Text
chunk
chunk
Count
chunk
ToLines
dispose
each
Chunk
each
Chunk
OfLines
is
Binary
next
Chunk
next
Chunk
OfLines
peek
Lines
read
Constructors
constructor
new
String
Streamer
(
src
:
any
, params
?:
StreamerParams
)
:
StringStreamer
Parameters
src:
any
Default value
params:
StreamerParams
= {}
Returns
StringStreamer
Properties
Protected
__partial
Line
__partial
Line
:
string
= ""
Protected
__pointer
__pointer
:
number
= 0
binary
binary
:
boolean
chunk
Size
chunk
Size
:
number
= 1024 * 1024 * 10
compressed
compressed
:
string
|
false
data
data
:
any
json
json
:
boolean
newline
newline
:
string
= ""
src
src
:
any
xml
xml
:
boolean
Accessors
__src
Name
get
__srcName
(
)
:
string
Returns
string
type
get
type
(
)
:
string
Returns
string
Methods
Protected
_chunk
_chunk
(
start
:
number
, end
:
number
)
:
any
Parameters
start:
number
end:
number
Returns
any
_read
_read
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
as
Text
as
Text
(
)
:
any
Returns
any
chunk
chunk
(
start
:
number
)
:
any
Parameters
start:
number
Returns
any
chunk
Count
chunk
Count
(
)
:
number
Returns
number
chunk
ToLines
chunk
ToLines
(
chunk
:
string
|
Uint8Array
, partialLine
:
string
, isLast
:
boolean
)
:
{
lines
:
string
[]
;
partialLine
:
string
}
Parameters
chunk:
string
|
Uint8Array
partialLine:
string
isLast:
boolean
Returns
{
lines
:
string
[]
;
partialLine
:
string
}
lines
:
string
[]
partial
Line
:
string
dispose
dispose
(
)
:
void
Returns
void
each
Chunk
each
Chunk
(
callback
:
(
chunk
:
string
|
Uint8Array
, chunkNo
:
number
, chunkCount
:
number
)
=>
void
)
:
void
Parameters
callback:
(
chunk
:
string
|
Uint8Array
, chunkNo
:
number
, chunkCount
:
number
)
=>
void
(
chunk
:
string
|
Uint8Array
, chunkNo
:
number
, chunkCount
:
number
)
:
void
Parameters
chunk:
string
|
Uint8Array
chunkNo:
number
chunkCount:
number
Returns
void
Returns
void
each
Chunk
OfLines
each
Chunk
OfLines
(
callback
:
(
chunk
:
string
[]
, chunkNo
:
number
, chunkCount
:
number
)
=>
void
)
:
void
Parameters
callback:
(
chunk
:
string
[]
, chunkNo
:
number
, chunkCount
:
number
)
=>
void
(
chunk
:
string
[]
, chunkNo
:
number
, chunkCount
:
number
)
:
void
Parameters
chunk:
string
[]
chunkNo:
number
chunkCount:
number
Returns
void
Returns
void
is
Binary
is
Binary
(
)
:
string
|
false
|
true
Returns
string
|
false
|
true
next
Chunk
next
Chunk
(
)
:
any
Returns
any
next
Chunk
OfLines
next
Chunk
OfLines
(
)
:
undefined
|
string
[]
Returns
undefined
|
string
[]
peek
Lines
peek
Lines
(
m
:
number
)
:
string
[]
Parameters
m:
number
Returns
string
[]
read
read
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
Globals
String
Streamer
constructor
__partial
Line
__pointer
binary
chunk
Size
compressed
data
json
newline
src
xml
__src
Name
type
_chunk
_read
as
Text
chunk
chunk
Count
chunk
ToLines
dispose
each
Chunk
each
Chunk
OfLines
is
Binary
next
Chunk
next
Chunk
OfLines
peek
Lines
read
Generated using
TypeDoc
Provides a streamer interface for a string. Used in unit tests