lsync API
Preparing search index...
@lsync/client
CollectionType
Type Alias CollectionType<T, TKey, TChildren, TApi>
CollectionType
:
{
all
(
params
?:
CollectionScopeParams
)
:
Collection
<
T
,
TKey
>
;
dispose
()
:
Promise
<
void
>
;
usage
()
:
CollectionUsage
[]
;
with
(
params
:
CollectionScopeParams
,
)
:
CollectionType
<
T
,
TKey
,
TChildren
,
TApi
>
;
withId
(
id
:
TKey
,
childParam
?:
string
)
:
CollectionEntity
<
T
,
TKey
,
TChildren
>
;
}
&
CollectionMutations
<
T
,
TKey
>
&
ChildManagers
<
TChildren
>
&
CollectionApiMethods
<
TApi
,
>
Type Parameters
T
extends
object
TKey
extends
string
|
number
TChildren
extends
CollectionTypeChildren
=
{}
TApi
extends
CollectionTypeApi
<
T
,
TKey
>
=
{}
Type Declaration
all
:
function
all
(
params
?:
CollectionScopeParams
)
:
Collection
<
T
,
TKey
>
Parameters
Optional
params
:
CollectionScopeParams
Returns
Collection
<
T
,
TKey
>
dispose
:
function
dispose
()
:
Promise
<
void
>
Clean up and remove every scoped collection created by this collection type.
Returns
Promise
<
void
>
usage
:
function
usage
()
:
CollectionUsage
[]
Returns
CollectionUsage
[]
with
:
function
with
(
params
:
CollectionScopeParams
)
:
CollectionType
<
T
,
TKey
,
TChildren
,
TApi
>
Parameters
params
:
CollectionScopeParams
Returns
CollectionType
<
T
,
TKey
,
TChildren
,
TApi
>
withId
:
function
withId
(
id
:
TKey
,
childParam
?:
string
)
:
CollectionEntity
<
T
,
TKey
,
TChildren
>
Parameters
id
:
TKey
Optional
childParam
:
string
Returns
CollectionEntity
<
T
,
TKey
,
TChildren
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
lsync API
Loading...
Clean up and remove every scoped collection created by this collection type.