Class Slice<E>

Type Parameters

Hierarchy

AbstractStore<E>
- Slice

Index

Constructors

constructor

new Slice<E>(label, predicate, eStore): Slice<E>
perform initial notification to all observers, such that operations like combineLatest{} will execute at least once.
Type Parameters
- E
Parameters
- label: string
  The slice label
- predicate: Predicate<E>
  The slice predicate
- eStore: EStore<E>
  The EStore instance containing the elements considered for slicing
Returns Slice<E>
Example
```
 //Empty slice
 new Slice<Todo>(Todo.COMPLETE, todo=>!todo.complete);

 //Initialized slice
 let todos = [new Todo(false, "You complete me!"), 
              new Todo(true, "You completed me!")];
 new Slice<Todo>(Todo.COMPLETE, todo=>!todo.complete, todos);
```
Overrides AbstractStore.constructor
- Defined in Slice.ts:34

Properties

`Protected` _query

_query: string = ''

The current query state.

config

config: StoreConfig

The configuration for the store.

eStore

eStore: EStore<E>

The EStore instance containing the elements considered for slicing

entries

entries: Map<string, E> = ...

Primary index for the stores elements.

idEntries

idEntries: Map<string, E> = ...

The element entries that are keyed by an id generated on the server.

label

label: string

The slice label

`Protected` notify

notify: ReplaySubject<E[]> = ...

Create notifications that broacast the entire set of entries.

`Protected` notifyDelta

notifyDelta: ReplaySubject<Delta<E>> = ...

Create notifications that broacast store or slice delta state changes.

`Protected` notifyQuery

notifyQuery: ReplaySubject<string> = ...

Notifies observers of the store query.

obs

obs: Observable<E[]> = ...

An Observable<E[]> reference to the entities in the store or Slice instance.

predicate

predicate: Predicate<E>

The slice predicate

Accessors

GUID_KEY

get GUID_KEY(): string
The current guid key for the EStore instance.

Returns string
this.config.guidKey;
Inherited from AbstractStore.GUID_KEY
- Defined in AbstractStore.ts:75

ID_KEY

get ID_KEY(): string
The current id key for the EStore instance.

Returns string
this.config.idKey;
Inherited from AbstractStore.ID_KEY
- Defined in AbstractStore.ts:68

query

get query(): string
Returns string
A snapshot of the query state.
Inherited from AbstractStore.query
- Defined in AbstractStore.ts:49
set query(query): void
Sets the current query state and notifies observers.
Parameters
- query: string
Returns void
Inherited from AbstractStore.query
- Defined in AbstractStore.ts:41

Methods

allSnapshot

allSnapshot(): E[]
Snapshot of all entries.

Returns E[]
Snapshot array of all the elements the entities the store contains.
Example: Observe a snapshot of all the entities in the store.
```
let selectedTodos:Todo[] = source.allSnapshot();
```
Inherited from AbstractStore.allSnapshot
- Defined in AbstractStore.ts:212

contains

contains(target): boolean
Returns true if the entries contain the identified instance.
Parameters
- target: string | E
  Either an instance of type E or a guid identifying the instance.
Returns boolean
true if the instance identified by the guid exists, false otherwise.
Example
```
<pre>
  let contains:boolean = source.contains(guid);
  </pre>
```
Inherited from AbstractStore.contains
- Defined in AbstractStore.ts:228

containsById

containsById(target): boolean
Returns true if the entries contain the identified instance.
Parameters
- target: string | E
  Either an instance of type E or a id identifying the instance.
Returns boolean
true if the instance identified by the id exists, false otherwise.
Example
```
<pre>
  let contains:boolean = source.contains(guid);
  </pre>
```
Inherited from AbstractStore.containsById
- Defined in AbstractStore.ts:247

count

count(p?): Observable<number>
Returns the number of entries contained.
Parameters
- Optional p: Predicate<E>
  The predicate to apply in order to filter the count
Returns Observable<number>
Inherited from AbstractStore.count
- Defined in AbstractStore.ts:182

countSnapshot

countSnapshot(p?): number
Returns a snapshot of the number of entries contained in the store.
Parameters
- Optional p: Predicate<E>
  The predicate to apply in order to filter the count
Returns number
Inherited from AbstractStore.countSnapshot
- Defined in AbstractStore.ts:195

delete

delete(e): void
Delete an element from the slice.
Parameters
- e: E | E[]
  The element to be deleted if it satisfies the predicate
Returns void
- Defined in Slice.ts:101

deleteA

deleteA(e): void
Parameters
- e: E[]
  The elements to be deleted if they satisfy the predicate
Returns void
- Defined in Slice.ts:125

deleteN

deleteN(...e): void
Parameters
- Rest ...e: E[]
  The elements to be deleted if it satisfies the predicate
Returns void
- Defined in Slice.ts:118

destroy

destroy(): void
Calls complete on all ReplaySubject instances.

Call destroy when disposing of the store.

Returns void
Inherited from AbstractStore.destroy
- Defined in AbstractStore.ts:333

equalsByGUID

equalsByGUID(e1, e2): boolean
Compare entities by GUID
Parameters
- e1: any
  The first entity
- e2: any
  The second entity
Returns boolean
true if the two entities have equal GUID ids
Example: Compare todo1 with todo2 by gid.
```
if (equalsByGUID(todo1, todo2)){...};
```
Inherited from AbstractStore.equalsByGUID
- Defined in AbstractStore.ts:309

equalsByID

equalsByID(e1, e2): boolean
Compare entities by ID
Parameters
- e1: any
  The first entity
- e2: any
  The second entity
Returns boolean
true if the two entities have equal ID ids
Example: Compare todo1 with todo2 by id.
```
if (equalsByID(todo1, todo2)){...};
```
Inherited from AbstractStore.equalsByID
- Defined in AbstractStore.ts:325

findOne

findOne(guid): undefined | E
Find and return the entity identified by the GUID parameter if it exists and return it.
Parameters
- guid: string
Returns undefined | E
The entity instance if it exists, null otherwise
Inherited from AbstractStore.findOne
- Defined in AbstractStore.ts:262

findOneByID

findOneByID(id): undefined | E
Find and return the entity identified by the ID parameter if it exists and return it.
Parameters
- id: string
Returns undefined | E
The entity instance if it exists, null otherwise
Inherited from AbstractStore.findOneByID
- Defined in AbstractStore.ts:273

isEmpty

isEmpty(): Observable<boolean>
Check whether the store is empty.

Returns Observable<boolean>
A hot Observable that indicates whether the store is empty.
Example
```
const empty$:Observable<boolean> = source.isEmpty();
```
Inherited from AbstractStore.isEmpty
- Defined in AbstractStore.ts:160

isEmptySnapshot

isEmptySnapshot(): boolean
Check whether the store is empty.

Returns boolean
A snapshot that indicates whether the store is empty.
Example
```
const empty:boolean = source.isEmptySnapshot();
```
Inherited from AbstractStore.isEmptySnapshot
- Defined in AbstractStore.ts:174

`Protected` notifyAll

notifyAll(v, delta): void
Call all the notifiers at once.
Parameters
- v: E[]
- delta: Delta<E>
Returns void
Inherited from AbstractStore.notifyAll
- Defined in AbstractStore.ts:108

observe

observe(sort?): Observable<E[]>
Observe store state changes.
Parameters
- Optional sort: ((a, b) => number)
  Optional sorting function yielding a sorted observable.
  - - (a, b): number
    - Parameters
      a: any
      b: any
      Returns number
Returns Observable<E[]>
Example
```
let todos$ = source.observe();
//or with a sort by title function
let todos$ = source.observe((a, b)=>(a.title > b.title ? -1 : 1));
```
Inherited from AbstractStore.observe
- Defined in AbstractStore.ts:124

observeDelta

observeDelta(): Observable<Delta<E>>
Observe delta updates.

Returns Observable<Delta<E>>
Example
```
let todos$ = source.observeDelta();
```
Inherited from AbstractStore.observeDelta
- Defined in AbstractStore.ts:146

observeQuery

observeQuery(): Observable<string>
Observe the query.

Returns Observable<string>
Example
```
<pre>
 let query$ = source.observeQuery();
 </pre>
```
Inherited from AbstractStore.observeQuery
- Defined in AbstractStore.ts:60

post

post(e): void
Add the element if it satisfies the predicate and notify subscribers that an element was added.
Parameters
- e: E | E[]
  The element to be considered for slicing
Returns void
- Defined in Slice.ts:53

postA

postA(e): void
Add the elements if they satisfy the predicate and notify subscribers that elements were added.
Parameters
- e: E[]
  The element to be considered for slicing
Returns void
- Defined in Slice.ts:83

postN

postN(...e): void
Add the elements if they satisfy the predicate and notify subscribers that elements were added.
Parameters
- Rest ...e: E[]
  The element to be considered for slicing
Returns void
- Defined in Slice.ts:73

put

put(e): void
Update the slice when an Entity instance mutates.
Parameters
- e: E | E[]
  The element to be added or deleted depending on predicate reevaluation
Returns void
- Defined in Slice.ts:143

putA

putA(e): void
Parameters
- e: E[]
  The elements to be put
Returns void
- Defined in Slice.ts:177

putN

putN(...e): void
Update the slice with mutated Entity instances.
Parameters
- Rest ...e: E[]
  The elements to be deleted if it satisfies the predicate
Returns void
- Defined in Slice.ts:170

reset

reset(): void
Resets the slice to empty.

Returns void
- Defined in Slice.ts:209

select

select(p): E[]
Snapshot of the entries that match the predicate.
Parameters
- p: Predicate<E>
  The predicate used to query for the selection.
Returns E[]
A snapshot array containing the entities that match the predicate.
Example: Select all the Todo instances where the title length is greater than 100.
```
let todos:Todo[]=store.select(todo=>todo.title.length>100);
```
Inherited from AbstractStore.select
- Defined in AbstractStore.ts:288

test

test(p, e): E[]
Utility method that applies the predicate to an array of entities and return the ones that pass the test.

Used to create an initial set of values that should be part of the Slice.
Parameters
- p: Predicate<E>
- e: E[]
Returns E[]
The the array of entities that pass the predicate test.
- Defined in Slice.ts:229

Class Slice<E>

Type Parameters

E

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

E

Parameters

label: string

predicate: Predicate<E>

eStore: EStore<E>

Returns Slice<E>

Example

Properties

Protected _query

config

eStore

entries

idEntries

label

Protected notify

Protected notifyDelta

Protected notifyQuery

obs

predicate

Accessors

GUID_KEY

Returns string

ID_KEY

Returns string

query

Returns string

Parameters

query: string

Returns void

Methods

allSnapshot

Returns E[]

Example: Observe a snapshot of all the entities in the store.

contains

Parameters

target: string | E

Returns boolean

Example

containsById

Parameters

target: string | E

Returns boolean

Example

count

Parameters

Optional p: Predicate<E>

Returns Observable<number>

countSnapshot

Parameters

Optional p: Predicate<E>

Returns number

delete

Parameters

e: E | E[]

Returns void

deleteA

Parameters

e: E[]

Returns void

deleteN

Parameters

Rest ...e: E[]

Returns void

destroy

Returns void

equalsByGUID

Parameters

e1: any

`Protected` _query

`Protected` notify

`Protected` notifyDelta

`Protected` notifyQuery

`Optional` p: Predicate<E>

`Optional` p: Predicate<E>

`Rest` ...e: E[]

`Protected` notifyAll

`Optional` sort: ((a, b) => number)

`Rest` ...e: E[]

`Rest` ...e: E[]