Meldbase TypeScript API
Preparing search index...
@meldbase/client
MeldbaseClient
Class MeldbaseClient
Index
Constructors
constructor
Accessors
realtime
Protocol
Methods
call
close
collection
count
execute
Mutation
fetch
Query
group
Count
insert
One
subscribe
Constructors
constructor
new
MeldbaseClient
(
options
:
ClientOptions
)
:
MeldbaseClient
Parameters
options
:
ClientOptions
Returns
MeldbaseClient
Accessors
realtime
Protocol
get
realtimeProtocol
()
:
ProtocolDescriptor
|
undefined
Returns
ProtocolDescriptor
|
undefined
Methods
call
call
<
T
extends
Value
=
Value
>
(
method
:
string
,
input
:
Value
,
options
?:
CallOptions
,
)
:
Promise
<
T
>
Type Parameters
T
extends
Value
=
Value
Parameters
method
:
string
input
:
Value
options
:
CallOptions
= {}
Returns
Promise
<
T
>
close
close
()
:
void
Returns
void
collection
collection
<
T
extends
Document
=
Document
>
(
name
:
string
)
:
RemoteCollection
<
T
>
Type Parameters
T
extends
Document
=
Document
Parameters
name
:
string
Returns
RemoteCollection
<
T
>
count
count
(
collection
:
string
,
query
:
QuerySpec
,
signal
?:
AbortSignal
,
)
:
Promise
<
CountResult
>
Parameters
collection
:
string
query
:
QuerySpec
Optional
signal
:
AbortSignal
Returns
Promise
<
CountResult
>
execute
Mutation
executeMutation
(
collection
:
string
,
action
:
"updateOne"
|
"updateMany"
|
"deleteOne"
|
"deleteMany"
,
query
:
QuerySpec
,
update
?:
MutationSpec
,
signal
?:
AbortSignal
,
)
:
Promise
<
MutationResult
|
DeleteResult
>
Parameters
collection
:
string
action
:
"updateOne"
|
"updateMany"
|
"deleteOne"
|
"deleteMany"
query
:
QuerySpec
Optional
update
:
MutationSpec
Optional
signal
:
AbortSignal
Returns
Promise
<
MutationResult
|
DeleteResult
>
fetch
Query
fetchQuery
<
T
extends
Document
>
(
collection
:
string
,
query
:
QuerySpec
,
signal
?:
AbortSignal
,
)
:
Promise
<
T
[]
>
Type Parameters
T
extends
Document
Parameters
collection
:
string
query
:
QuerySpec
Optional
signal
:
AbortSignal
Returns
Promise
<
T
[]
>
group
Count
groupCount
(
collection
:
string
,
query
:
QuerySpec
,
groupBy
:
string
,
signal
?:
AbortSignal
,
)
:
Promise
<
GroupCountResult
>
Parameters
collection
:
string
query
:
QuerySpec
groupBy
:
string
Optional
signal
:
AbortSignal
Returns
Promise
<
GroupCountResult
>
insert
One
insertOne
<
T
extends
Document
>
(
collection
:
string
,
document
:
InputDocument
,
signal
?:
AbortSignal
,
)
:
Promise
<
T
>
Type Parameters
T
extends
Document
Parameters
collection
:
string
document
:
InputDocument
Optional
signal
:
AbortSignal
Returns
Promise
<
T
>
subscribe
subscribe
(
collection
:
string
,
query
:
QuerySpec
,
listener
:
SnapshotListener
<
Document
>
,
options
:
SubscribeOptions
,
)
:
Unsubscribe
Parameters
collection
:
string
query
:
QuerySpec
listener
:
SnapshotListener
<
Document
>
options
:
SubscribeOptions
Returns
Unsubscribe
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Accessors
realtime
Protocol
Methods
call
close
collection
count
execute
Mutation
fetch
Query
group
Count
insert
One
subscribe
Meldbase TypeScript API
Loading...