@fireflysemantics/slice 17.0.14 → 17.0.17

package/lib/EStore.d.ts

@@ -7,39 +7,46 @@ import { Slice } from './Slice';
  * This `todoFactory` code will be used to illustrate the API examples.  The following
  * utilities are used in the tests and the API Typedoc examples contained here.
  * @example Utilities for API Examples
-```
-export const enum TodoSliceEnum {
-  COMPLETE = "Complete",
-  INCOMPLETE = "Incomplete"
-}
-
-export class Todo {
-  constructor(public complete: boolean, public title: string,public gid?:string, public id?:string) {}
-}
-
-export let todos = [new Todo(false, "You complete me!"), new Todo(true, "You completed me!")];
-
-export function todosFactory():Todo[] {
-  return [new Todo(false, "You complete me!"), new Todo(true, "You completed me!")];
-}
- ```
+ * ```
+ * export const enum TodoSliceEnum {
+ *    COMPLETE = "Complete",
+ *    INCOMPLETE = "Incomplete"
+ * }
+ * export class Todo {
+ *    constructor(
+ *         public complete: boolean,
+ *         public title: string,
+ *         public gid?:string,
+ *         public id?:string) {}
+ * }
+ *
+ * export let todos = [new Todo(false, "You complete me!"), new Todo(true, "You completed me!")];
+ *
+ * export function todosFactory():Todo[] {
+ *   return [new Todo(false, "You complete me!"), new Todo(true, "You completed me!")];
+ * }
+ * ```
  */
 export declare class EStore<E> extends AbstractStore<E> {
     /**
      * Store constructor (Initialization with element is optional)
      *
      * perform initial notification to all observers,
-     * such that function like {@link combineLatest}{}
+     * such that functions like {@link combineLatest}{}
      * will execute at least once.
-     * @param entities
-     * @example Dynamic `EStore<Todo>` Creation
-  ```
-  // Initialize the Store
-  let store: EStore<Todo> = new EStore<Todo>(todosFactory());
-  ```*/
+     *
+     * @param entities The entities to initialize the store with.
+     * @param config The optional configuration instance.
+     *
+     * @example EStore<Todo> Creation
+     * ```
+     * // Initialize the Store
+     * let store: EStore<Todo> = new EStore<Todo>(todosFactory());
+     * ```
+     */
     constructor(entities?: E[], config?: StoreConfig);
     /**
-     * Calls complete on all {@link BehaviorSubject} instances.
+     * Calls complete on all EStore {@link ReplaySubject} instances.
      *
      * Call destroy when disposing of the store.
      */
@@ -51,16 +58,15 @@ export declare class EStore<E> extends AbstractStore<E> {
      * it will be deleted.  If the store
      * does not contains the entity,
      * it is added.
-     * @param e
-     * @example Toggle the `Todo` instance
-  ```
-  estore.post(todo);
-  // Remove todo
-  estore.toggle(todo);
-  // Add it back
-  estore.toggle(todo);
-  
-  ```
+     * @param e The entity to toggle
+     * @example Toggle the Todo instance
+     * ```
+     * estore.post(todo);
+     * // Remove todo
+     * estore.toggle(todo);
+     * // Add it back
+     * estore.toggle(todo);
+     * ```
      */
     toggle(e: E): void;
     /**
@@ -84,26 +90,26 @@ export declare class EStore<E> extends AbstractStore<E> {
      * change detection in the event that it maintains
      * a reference to the `active` state `Map` instance.
      *
-     * @example Add a `todo1` and `todo2` as active
-  ```
-  addActive(todo1);
-  addActive(todo2);
-  ```
+     * @example Add todo1 and todo2 as active
+     * ```
+     * addActive(todo1);
+     * addActive(todo2);
+     * ```
      */
     addActive(e: E): void;
     /**
-     * Delete an entity as active.
+     * Delete an active entity.
      *
      * Also we clone the map prior to broadcasting it with
      * `notifyActive` to make sure we will trigger Angular
      * change detection in the event that it maintains
      * a reference to the `active` state `Map` instance.
      *
-     * @example Mark a `todo` instance as active
-    ```
-  deleteActive(todo1);
-  deleteActive(todo2);
-    ```
+     * @example Remove todo1 and todo2 as active entities
+     * ```
+     * deleteActive(todo1);
+     * deleteActive(todo2);
+     * ```
      */
     deleteActive(e: E): void;
     /**
@@ -114,20 +120,20 @@ export declare class EStore<E> extends AbstractStore<E> {
      * change detection in the event that it maintains
      * a reference to the `active` state `Map` instance.
      *
-     * @example Mark a `todo` instance as active
-    ```
-  deleteActive(todo1);
-  deleteActive(todo2);
-    ```
+     * @example Clear active todo instances
+     * ```
+     * store.clearActive();
+     * ```
      */
     clearActive(): void;
     /**
-     * Observe the active entity.
+     * Observe the active entities.
+     *
      * @example
-       <pre>
-      let active$ = source.observeActive();
-      </pre>
-    */
+     * ```
+     * let active$ = store.observeActive();
+     * ```
+     */
     observeActive(): Observable<Map<string, E>>;
     /**
      * Observe the active entity.
@@ -169,24 +175,81 @@ export declare class EStore<E> extends AbstractStore<E> {
     set loading(loading: boolean);
     /**
      * @return A snapshot of the loading state.
+     * @example Create a reference to the loading state
+     * ```
+     * const loading:boolean = todoStore.loading;
+     * ```
      */
     get loading(): boolean;
     /**
      * Observe loading.
+     *
+     * Note that this obverable piped through
+     * `takeWhile(v->v, true), such that it will
+     * complete after each emission.
+     *
+     * See:
+     * https://fireflysemantics.medium.com/waiting-on-estore-to-load-8dcbe161613c
+     *
+     * For more details.
+     * Also note that v=>v is the same as v=>v!=false
+     *
      * @example
-       <pre>
-      let loading$ = source.observeLoading();
-      </pre>
-  
-      Note that this obverable piped through
-      `takeWhile(v->v, true), such that it will
-      complete after each emission.
-  
-      See:
-      https://medium.com/@ole.ersoy/waiting-on-estore-to-load-8dcbe161613c
-  
-      For more details.
-    */
+     * ```
+     * const observeLoadingHandler: Observer<boolean> = {
+     *   complete: () => {
+     *     console.log(`Data Loaded and Observable Marked as Complete`);
+     *   }, // completeHandler
+     *   error: () => {
+     *     console.log(`Any Errors?`);
+     *   }, // errorHandler
+     *   next: (l) => {
+     *     console.log(`Data loaded and loading is ${l}`);
+     *   },
+     * };
+     *
+     * const observeLoadingResubscribeHandler: Observer<boolean> = {
+     *   complete: () => {
+     *     console.log(`Data Loaded and Resubscribe Observable Marked as Complete`);
+     *   }, // completeHandler
+     *   error: () => {
+     *     console.log(`Any Resubscribe Errors?`);
+     *   }, // errorHandler
+     *   next: (l) => {
+     *     console.log(`Data loaded and resusbscribe loading  value is ${l}`);
+     *   },
+     * };
+     *
+     * const todoStore: EStore<Todo> = new EStore();
+     * //============================================
+     * // Loading is true by default
+     * //============================================
+     * console.log(`The initial value of loading is ${todoStore.loading}`);
+     * //============================================
+     * // Observe Loading
+     * //============================================
+     * let loading$: Observable<boolean> = todoStore.observeLoading();
+     * loading$.subscribe((l) => console.log(`The value of loading is ${l}`));
+     *
+     * todoStore.loading = false;
+     * loading$.subscribe(observeLoadingHandler);
+     * //============================================
+     * // The subscription no longer fires
+     * //============================================
+     * todoStore.loading = true;
+     * todoStore.loading = false;
+     *
+     * //============================================
+     * // The subscription no longer fires,
+     * // so if we want to observe loading again
+     * // resusbscribe.
+     * //============================================
+     * todoStore.loading = true;
+     * loading$ = todoStore.observeLoading();
+     * loading$.subscribe(observeLoadingResubscribeHandler);
+     * todoStore.loading = false;
+     * ```
+     */
     observeLoading(): Observable<boolean>;
     /**
      * Notfiies when loading has completed.
@@ -282,92 +345,95 @@ export declare class EStore<E> extends AbstractStore<E> {
     /**
      * Post (Add a new) element(s) to the store.
      * @param e An indiidual entity or an array of entities
-     * @example Post a `todo`.
-  ```
-  store.post(todo);
-  ```
+     * @example Post a Todo instance.
+     *
+     *```
+     * store.post(todo);
+     *```
      */
     post(e: E | E[]): void;
     /**
-     * Post elements to the store.
+     * Post N entities to the store.
      * @param ...e
-     * @example Post two `Todo` instances.
-  ```
-  store.post(todo1, todo2);
-  ```
+     * @example Post two Todo instances.
+     * ```
+     * store.post(todo1, todo2);
+     * ```
      */
     postN(...e: E[]): void;
     /**
      * Post (Add) an array of elements to the store.
      * @param e
-     * @example Post a `Todo` array.
-  ```
-  store.post([todo1, todo2]);
-  ```
+     * @example Post a Todo array.
+     *
+     * ```
+     * store.post([todo1, todo2]);
+     * ```
      */
     postA(e: E[]): void;
     /**
-     * Put (Update) an element.
+     * Put (Update) an entity.
      * @param e
      * @example Put a Todo instance.
-  ```
-  store.put(todo1);
-  ```
+     * ```
+     * store.put(todo1);
+     * ```
      */
     put(e: E | E[]): void;
     /**
      * Put (Update) an element or add an element that was read from a persistence source
      * and thus already has an assigned global id`.
-     * @param e
-     * @example Put Todo instances.
-  ```
-  store.put(todo1, todo2);
-  ```
+     * @param e The enetity instances to update.
+     * @example Put N Todo instances.
+     *
+     * ```
+     * store.put(todo1, todo2);
+     * ```
      */
     putN(...e: E[]): void;
     /**
-     * Put (Update) the array of elements.
-     * @param e
-     * @example Put Todo instances.
-  ```
-  store.put([todo1, todo2]);
-  ```
+     * Put (Update) the array of enntities.
+     * @param e The array of enntities to update
+     * @example Put an array of Todo instances.
+     * ```
+     * store.put([todo1, todo2]);
+     * ```
      */
     putA(e: E[]): void;
     /**
      * Delete (Update) the array of elements.
      * @param e
      * @example Delete todo1.
-  ```
-  store.delete(todo1]);
-  ```
+     * ```
+     * store.delete(todo1]);
+     * ```
      */
     delete(e: E | E[]): void;
     /**
      * Delete N elements.
      * @param ...e
-     * @example Put Todo instances.
-  ```
-  store.delete(todo1, todo2);
-  ```
+     * @example Delete N Todo instance argument.
+     * ```
+     * store.deleteN(todo1, todo2);
+     * ```
      */
     deleteN(...e: E[]): void;
     /**
-     * Delete N elements.
-     * @param ...e
-     * @example Put Todo instances.
-  ```
-  store.delete(todo1, todo2);
-  ```
+     * Delete an array of elements.
+     * @param e The array of instances to be deleted
+     * @example Delete the array of Todo instances.
+     * ```
+     * store.deleteA([todo1, todo2]);
+     * ```
      */
     deleteA(e: E[]): void;
     /**
      * Delete elements by {@link Predicate}.
      * @param p The predicate.
-     * @example Put Todo instances.
-  ```
-  store.delete(todo1, todo2);
-  ```
+     * @example Delete the Todo instances.
+     * ```
+     * store.delete(todo1, todo2);
+     * ```
      */
     deleteP(p: Predicate<E>): void;
     /**
@@ -391,9 +457,9 @@ export declare class EStore<E> extends AbstractStore<E> {
      * send their own delta notification.
      *
      * @example Reset the store.
-  ```
-  store.reset();
-  ```
+     * ```
+     * store.reset();
+     * ```
      */
     reset(): void;
     /**

package/lib/Slice.d.ts

@@ -16,15 +16,15 @@ export declare class Slice<E> extends AbstractStore<E> {
      * @param eStore The EStore instance containing the elements considered for slicing
      *
      * @example
-       <pre>
-       //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);
-       </pre>
+     * ```
+     *  //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);
+     *  ```
      */
     constructor(label: string, predicate: Predicate<E>, eStore: EStore<E>);
     /**

package/lib/models/Delta.d.ts

@@ -1,6 +1,6 @@
 import { ActionTypes } from "./ActionTypes";
 /**
- * Delta update interface models
+ * The Delta update interface models
  * the type of the update and the entities
  * associated with the update.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fireflysemantics/slice",
-  "version": "17.0.14",
+  "version": "17.0.17",
   "peerDependencies": {
     "nanoid": "^5.0.4",
     "@types/nanoid": "*",