Search
Preparing search index...
The search index is not available
split-shell-buffer — Reference
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
split-shell-buffer — Reference
Index
Namespaces
Child
Process
Sequence
Func
to
String
Enumerations
Digit
Special
Character
Classes
Internal
Stream
Error
Renamable
Error
Splitter
Object
Std
Err
Error
Std
Out
Error
String
Writable
Interfaces
Array
Like
Constructor
Options
Element
Splitter
To
String
Options
Writable
Type aliases
Code
Data
Func
Iterable
Stream
Maybe
Func
Sequence
Variables
End
End
OfLine
RESET
Seperator
Start
Start
Follow
ZERO_
AND_
SEP
Zero
array
Equal
sym
Data
sym
Encoding
Functions
create
from
Child
Process
from
Evented
Stream
from
Iterable
from
Iterable
Stream
from
String
is
Reset
Sequence
iterate
Elements
lines
simple
Flatten
write
writeln
Type aliases
Code
Code
:
number
Data
Data
:
AsyncIterable
<
Code
>
|
Iterable
<
Code
>
Func
Func<Return, Args>
:
(
...
args
:
Args
)
=>
Return
Type parameters
Return
Args
:
any
[]
Type declaration
(
...
args
:
Args
)
:
Return
Parameters
Rest
...
args:
Args
Returns
Return
Iterable
Stream
Iterable
Stream
:
AsyncIterable
<
Buffer
|
string
>
Maybe
Func
Maybe
Func<Return, Args>
:
Return
|
Func
<
Return
,
Args
>
Type parameters
Return
Args
:
any
[]
Sequence
Sequence
:
ArrayLike
<
Code
>
Variables
End
End
:
SpecialCharacter
End
OfLine
End
OfLine
:
SpecialCharacter
Const
RESET
RESET
:
(
SpecialCharacter
|
Digit
)
[]
= [Start, StartFollow, Zero, End]
Seperator
Seperator
:
SpecialCharacter
Start
Start
:
SpecialCharacter
Start
Follow
Start
Follow
:
SpecialCharacter
Const
ZERO_
AND_
SEP
ZERO_
AND_
SEP
:
Set
<
SpecialCharacter
|
Digit
>
= new Set([Zero, Seperator])
Zero
Zero
:
Digit
Const
array
Equal
array
Equal
:
any
= createArrayEqual<types.Sequence>()
Const
sym
Data
sym
Data
:
unique symbol
= Symbol('symData')
Const
sym
Encoding
sym
Encoding
:
unique symbol
= Symbol('symEncoding')
Functions
create
create
(
param
:
ConstructorOptions
)
:
SplitterObject
Parameters
param:
ConstructorOptions
Returns
SplitterObject
from
Child
Process
from
Child
Process<Chunk>
(
cp
:
ChildProcess
<
Chunk
>
)
:
SplitterObject
Type parameters
Chunk
:
string
|
Buffer
Parameters
cp:
ChildProcess
<
Chunk
>
Returns
SplitterObject
Const
from
Evented
Stream
from
Evented
Stream<Chunk>
(
stream
:
types.EventedStream
<
Chunk
>
)
:
SplitterObject
Type parameters
Chunk
:
string
|
Buffer
Parameters
stream:
types.EventedStream
<
Chunk
>
Returns
SplitterObject
Const
from
Iterable
from
Iterable
(
data
:
types.Data
)
:
SplitterObject
Parameters
data:
types.Data
Returns
SplitterObject
from
Iterable
Stream
from
Iterable
Stream
(
stream
:
types.IterableStream
)
:
SplitterObject
Parameters
stream:
types.IterableStream
Returns
SplitterObject
Const
from
String
from
String
(
text
:
string
)
:
SplitterObject
Parameters
text:
string
Returns
SplitterObject
Const
is
Reset
Sequence
is
Reset
Sequence
(
sequence
:
Iterable
<
types.Code
>
)
:
boolean
Parameters
sequence:
Iterable
<
types.Code
>
Returns
boolean
iterate
Elements
iterate
Elements
(
splitter
:
Splitter
)
:
AsyncIterableIterator
<
Element
>
Parameters
splitter:
Splitter
Returns
AsyncIterableIterator
<
Element
>
lines
lines
(
splitter
:
Splitter
)
:
AsyncIterableIterator
<
types.Sequence
>
Parameters
splitter:
Splitter
Returns
AsyncIterableIterator
<
types.Sequence
>
simple
Flatten
simple
Flatten<Element>
(
container
:
Iterable
<
Iterable
<
Element
>
>
)
:
Generator
<
Element
,
void
,
undefined
>
Type parameters
Element
Parameters
container:
Iterable
<
Iterable
<
Element
>
>
Returns
Generator
<
Element
,
void
,
undefined
>
write
write
(
writable
:
Writable
, splitter
:
Splitter
)
:
Promise
<
void
>
Parameters
writable:
Writable
splitter:
Splitter
Returns
Promise
<
void
>
writeln
writeln
(
writable
:
Writable
, splitter
:
Splitter
)
:
Promise
<
void
>
Parameters
writable:
Writable
splitter:
Splitter
Returns
Promise
<
void
>
Globals
Externals
Child
Process
Sequence
Func
to
String
Digit
Special
Character
Internal
Stream
Error
Renamable
Error
Splitter
Object
Std
Err
Error
Std
Out
Error
String
Writable
Array
Like
Constructor
Options
Element
Splitter
To
String
Options
Writable
Code
Data
Func
Iterable
Stream
Maybe
Func
Sequence
End
End
OfLine
RESET
Seperator
Start
Start
Follow
ZERO_
AND_
SEP
Zero
array
Equal
sym
Data
sym
Encoding
create
from
Child
Process
from
Evented
Stream
from
Iterable
from
Iterable
Stream
from
String
is
Reset
Sequence
iterate
Elements
lines
simple
Flatten
write
writeln
Generated using
TypeDoc