ng-xtend API documentation
Home
Guides
GitHub
Preparing search index...
xt-store
XtSignalStore
Type Alias XtSignalStore<T>
A SignalStore that provides additional methods to manipulate ManagedDatas.
type
XtSignalStore
<
T
extends
ManagedData
=
ManagedData
>
=
{
entities
:
Signal
<
T
[]
>
;
entityMap
:
Signal
<
EntityMap
<
T
>
>
;
entityName
:
Signal
<
string
>
;
ids
:
Signal
<
EntityId
[]
>
;
loading
:
Signal
<
boolean
>
;
deleteEntity
(
id
:
string
)
:
Promise
<
boolean
>
;
fetchEntities
()
:
Promise
<
void
>
;
loadEntity
(
id
:
string
)
:
Promise
<
T
|
undefined
>
;
safeLoadEntity
(
id
:
string
)
:
Promise
<
T
>
;
searchEntities
(
...
criteria
:
XtStoreCriteria
<
T
>
[]
)
:
Observable
<
T
[]
>
;
storeEntity
(
toStore
:
T
)
:
Promise
<
T
>
;
updateStoreOptions
(
option
:
XtStoreEntityFeatureOptions
<
T
>
|
undefined
,
)
:
Promise
<
void
>
;
}
Type Parameters
T
extends
ManagedData
=
ManagedData
Index
Properties
entities
entity
Map
entity
Name
ids
loading
Methods
delete
Entity
fetch
Entities
load
Entity
safe
Load
Entity
search
Entities
store
Entity
update
Store
Options
Properties
entities
entities
:
Signal
<
T
[]
>
entity
Map
entityMap
:
Signal
<
EntityMap
<
T
>
>
entity
Name
entityName
:
Signal
<
string
>
ids
ids
:
Signal
<
EntityId
[]
>
loading
loading
:
Signal
<
boolean
>
Methods
delete
Entity
deleteEntity
(
id
:
string
)
:
Promise
<
boolean
>
Parameters
id
:
string
Returns
Promise
<
boolean
>
fetch
Entities
fetchEntities
()
:
Promise
<
void
>
Returns
Promise
<
void
>
load
Entity
loadEntity
(
id
:
string
)
:
Promise
<
T
|
undefined
>
Parameters
id
:
string
Returns
Promise
<
T
|
undefined
>
safe
Load
Entity
safeLoadEntity
(
id
:
string
)
:
Promise
<
T
>
Parameters
id
:
string
Returns
Promise
<
T
>
search
Entities
searchEntities
(
...
criteria
:
XtStoreCriteria
<
T
>
[]
)
:
Observable
<
T
[]
>
Parameters
...
criteria
:
XtStoreCriteria
<
T
>
[]
Returns
Observable
<
T
[]
>
store
Entity
storeEntity
(
toStore
:
T
)
:
Promise
<
T
>
Parameters
toStore
:
T
Returns
Promise
<
T
>
update
Store
Options
updateStoreOptions
(
option
:
XtStoreEntityFeatureOptions
<
T
>
|
undefined
,
)
:
Promise
<
void
>
Parameters
option
:
XtStoreEntityFeatureOptions
<
T
>
|
undefined
Returns
Promise
<
void
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
entities
entity
Map
entity
Name
ids
loading
Methods
delete
Entity
fetch
Entities
load
Entity
safe
Load
Entity
search
Entities
store
Entity
update
Store
Options
Home
Guides
GitHub
ng-xtend API documentation
Loading...
A SignalStore that provides additional methods to manipulate ManagedDatas.