beneath
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Client
Cursor
constructor
change
Cursor
connection
default
Page
Size
initial
Data
next
Cursor
stream
Qualifier
has
Next
has
Next
Changes
read
Next
read
Next
Changes
subscribe
Changes
Job
Stream
Client
Options
Query
Index
Result
Query
Log
Result
Record
Stream
Qualifier
Write
Result
Type parameters
TRecord =
any
Hierarchy
Cursor
Index
Constructors
constructor
Properties
change
Cursor
connection
default
Page
Size
initial
Data
next
Cursor
stream
Qualifier
Methods
has
Next
has
Next
Changes
read
Next
read
Next
Changes
subscribe
Changes
Constructors
constructor
new
Cursor<TRecord>
(
connection
:
Connection
, nextCursor
?:
string
, changeCursor
?:
string
, data
?:
Record
<
TRecord
>
[]
, streamQualifier
?:
string
|
{
instanceID
:
string
}
|
{
organization
:
string
;
project
:
string
;
stream
:
string
}
, defaultPageSize
?:
number
)
:
Cursor
<
TRecord
>
Type parameters
TRecord =
any
Parameters
connection:
Connection
Optional
nextCursor:
string
Optional
changeCursor:
string
Optional
data:
Record
<
TRecord
>
[]
Optional
streamQualifier:
string
|
{
instanceID
:
string
}
|
{
organization
:
string
;
project
:
string
;
stream
:
string
}
Optional
defaultPageSize:
number
Returns
Cursor
<
TRecord
>
Properties
Optional
change
Cursor
change
Cursor
:
string
Private
connection
connection
:
Connection
Private
Optional
default
Page
Size
default
Page
Size
:
number
Private
Optional
initial
Data
initial
Data
:
Record
<
TRecord
>
[]
Optional
next
Cursor
next
Cursor
:
string
Private
Optional
stream
Qualifier
stream
Qualifier
:
string
|
{
instanceID
:
string
}
|
{
organization
:
string
;
project
:
string
;
stream
:
string
}
Methods
has
Next
has
Next
(
)
:
boolean
Returns
boolean
has
Next
Changes
has
Next
Changes
(
)
:
boolean
Returns
boolean
read
Next
read
Next
(
opts
?:
ReadOptions
)
:
Promise
<
ReadResult
<
TRecord
>
>
Parameters
Optional
opts:
ReadOptions
Returns
Promise
<
ReadResult
<
TRecord
>
>
read
Next
Changes
read
Next
Changes
(
opts
?:
ReadOptions
)
:
Promise
<
ReadResult
<
TRecord
>
>
Parameters
Optional
opts:
ReadOptions
Returns
Promise
<
ReadResult
<
TRecord
>
>
subscribe
Changes
subscribe
Changes
(
opts
:
SubscribeOptions
<
TRecord
>
)
:
{
unsubscribe
:
(
)
=>
void
}
Parameters
opts:
SubscribeOptions
<
TRecord
>
Returns
{
unsubscribe
:
(
)
=>
void
}
unsubscribe
:
(
)
=>
void
(
)
:
void
Returns
void
Generated using
TypeDoc