Meldbase TypeScript API
Preparing search index...
client/src
RemoteLiveQuery
Interface RemoteLiveQuery<T>
Holds a compiled remote query that can fetch pages or subscribe to changing results.
interface
RemoteLiveQuery
<
T
extends
Document
>
{
collection
:
string
;
mode
:
"remote"
;
spec
:
QuerySpec
;
fetch
(
options
?:
{
signal
?:
AbortSignal
}
)
:
Promise
<
T
[]
>
;
fetchPage
(
options
?:
{
signal
?:
AbortSignal
}
)
:
Promise
<
PageResult
<
T
>
>
;
subscribe
(
listener
:
SnapshotListener
<
T
>
,
options
?:
SubscribeOptions
,
)
:
Unsubscribe
;
}
Type Parameters
T
extends
Document
Index
Properties
collection
mode
spec
Methods
fetch
fetch
Page
subscribe
Properties
Readonly
collection
collection
:
string
Readonly
mode
mode
:
"remote"
= ...
Readonly
spec
spec
:
QuerySpec
Methods
fetch
fetch
(
options
?:
{
signal
?:
AbortSignal
}
)
:
Promise
<
T
[]
>
Parameters
options
:
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
T
[]
>
fetch
Page
fetchPage
(
options
?:
{
signal
?:
AbortSignal
}
)
:
Promise
<
PageResult
<
T
>
>
Parameters
options
:
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
PageResult
<
T
>
>
subscribe
subscribe
(
listener
:
SnapshotListener
<
T
>
,
options
?:
SubscribeOptions
,
)
:
Unsubscribe
Parameters
listener
:
SnapshotListener
<
T
>
options
:
SubscribeOptions
= {}
Returns
Unsubscribe
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
collection
mode
spec
Methods
fetch
fetch
Page
subscribe
Meldbase TypeScript API
Loading...
Holds a compiled remote query that can fetch pages or subscribe to changing results.