Meldbase TypeScript API
Preparing search index...
client/src
RemoteCollection
Interface RemoteCollection<T>
Provides typed query, aggregation, and document operations for one remote collection.
interface
RemoteCollection
<
T
extends
Document
>
{
name
:
string
;
count
(
filter
?:
Filter
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
CountResult
>
;
deleteMany
(
filter
:
Filter
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
DeleteResult
>
;
deleteOne
(
filter
:
Filter
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
DeleteResult
>
;
find
(
filter
?:
Filter
,
options
?:
QueryOptions
)
:
RemoteLiveQuery
<
T
>
;
findOne
(
filter
?:
Filter
,
options
?:
FindOneOptions
&
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
T
|
undefined
>
;
groupCount
(
filter
:
Filter
|
undefined
,
groupBy
:
string
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
GroupCountResult
>
;
insertOne
<
U
extends
InputDocument
>
(
document
:
InsertDocument
<
T
,
U
>
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
T
>
;
updateMany
(
filter
:
Filter
,
update
:
Update
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
MutationResult
>
;
updateOne
(
filter
:
Filter
,
update
:
Update
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
MutationResult
>
;
}
Type Parameters
T
extends
Document
Index
Properties
name
Methods
count
delete
Many
delete
One
find
find
One
group
Count
insert
One
update
Many
update
One
Properties
Readonly
name
name
:
string
Methods
count
count
(
filter
?:
Filter
,
options
?:
{
signal
?:
AbortSignal
}
)
:
Promise
<
CountResult
>
Parameters
filter
:
Filter
= {}
options
:
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
CountResult
>
delete
Many
deleteMany
(
filter
:
Filter
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
DeleteResult
>
Parameters
filter
:
Filter
options
:
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
DeleteResult
>
delete
One
deleteOne
(
filter
:
Filter
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
DeleteResult
>
Parameters
filter
:
Filter
options
:
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
DeleteResult
>
find
find
(
filter
?:
Filter
,
options
?:
QueryOptions
)
:
RemoteLiveQuery
<
T
>
Parameters
filter
:
Filter
= {}
options
:
QueryOptions
= {}
Returns
RemoteLiveQuery
<
T
>
find
One
findOne
(
filter
?:
Filter
,
options
?:
FindOneOptions
&
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
T
|
undefined
>
Parameters
filter
:
Filter
= {}
options
:
FindOneOptions
&
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
T
|
undefined
>
group
Count
groupCount
(
filter
:
Filter
|
undefined
,
groupBy
:
string
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
GroupCountResult
>
Parameters
filter
:
Filter
|
undefined
groupBy
:
string
options
:
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
GroupCountResult
>
insert
One
insertOne
<
U
extends
InputDocument
>
(
document
:
InsertDocument
<
T
,
U
>
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
T
>
Type Parameters
U
extends
InputDocument
Parameters
document
:
InsertDocument
<
T
,
U
>
options
:
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
T
>
update
Many
updateMany
(
filter
:
Filter
,
update
:
Update
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
MutationResult
>
Parameters
filter
:
Filter
update
:
Update
options
:
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
MutationResult
>
update
One
updateOne
(
filter
:
Filter
,
update
:
Update
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
MutationResult
>
Parameters
filter
:
Filter
update
:
Update
options
:
{
signal
?:
AbortSignal
}
= {}
Returns
Promise
<
MutationResult
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
name
Methods
count
delete
Many
delete
One
find
find
One
group
Count
insert
One
update
Many
update
One
Meldbase TypeScript API
Loading...
Provides typed query, aggregation, and document operations for one remote collection.