@expressive/mvc 0.52.2-alpha.74 → 0.53.2

package/dist/index.d.ts

@@ -1,3 +1,30 @@
+/**
+ * Update callback function.
+ *
+ * @param key -
+ *   - `string` - property which has updated.
+ *   - `false` - a normal update has completed.
+ *   - `true` - initial event; instance is ready.
+ *   - `null` - terminal event; instance is expired.
+ * @param source - Instance of Model for which update has occured.
+ */
+type OnUpdate<T extends Model = any> = (this: T, key: unknown, source: T) => (() => void) | null | void;
+type OnAccess<T extends Model = any, R = unknown> = (from: T, key: string | number, value: R) => unknown;
+type Effect<T extends Model> = (this: T, proxy: T) => ((update: boolean | null) => void) | Promise<void> | null | void;
+type Event = number | string | null | boolean | symbol;
+declare function addListener<T extends Model>(subject: T, callback: OnUpdate<T>, select?: Event): () => boolean;
+declare function createProxy<T extends Model>(from: T, observer: OnAccess<T>): T;
+/**
+ * Create a side-effect which will update whenever values accessed change.
+ * Callback is called immediately and if ever values are stale.
+ *
+ * @param target - Instance of Model to observe.
+ * @param callback - Function to invoke when values change.
+ * @param requireValues - If `true` will throw if accessing a value which is `undefined`.
+ */
+declare function createEffect<T extends Model>(target: T, callback: Effect<Required<T>>, requireValues: true): () => void;
+declare function createEffect<T extends Model>(target: T, callback: Effect<T>, requireValues?: boolean): () => void;
+
 declare namespace Model {
     /** Any type of Model, using own class constructor as its identifier. */
     type Type<T extends Model = Model> = (abstract new (...args: any[]) => T) & typeof Model;
@@ -27,7 +54,7 @@ declare namespace Model {
     /** Value for a property managed by a model. */
     type Value<T extends Model, K extends Event<T>> = K extends keyof T ? Export<T[K]> : unknown;
     type OnEvent<T extends Model> = (this: T, key: unknown, source: T) => (() => void) | void | null;
-    type OnUpdate<T extends Model, K extends Event<T>> = (this: T, value: Value<T, K>, key: K, thisArg: K) => void;
+    type OnUpdate<T extends Model, K extends Event<T>> = (this: T, key: K, thisArg: K) => void;
     /**
      * Values from current state of given model.
      * Differs from `Values` as values here will drill
@@ -141,9 +168,10 @@ declare abstract class Model {
      * Properties which are not managed by this model will be ignored.
      *
      * @param assign - Object with properties to update.
+     * @param silent - If an update does occur, listeners will not be refreshed automatically.
      * @returns Promise resolving an array of keys updated, `undefined` (immediately) if a noop.
      */
-    set(assign: Model.Assign<this>): PromiseLike<Model.Event<this>[]> | undefined;
+    set(assign: Model.Assign<this>, silent?: boolean): PromiseLike<Model.Event<this>[]> | undefined;
     /**
      * Push an update. This will not change the value of associated property.
      *
@@ -159,15 +187,6 @@ declare abstract class Model {
      * @returns Promise resolves an array of keys updated.
      */
     set(key: Model.Event<this>): PromiseLike<Model.Event<this>[]>;
-    /**
-     * Update a property with value.
-     *
-     * @param key - property to update
-     * @param value - value to update property with (if the same as current, no update will occur)
-     * @param silent - if true, will not notify listeners of an update
-     * @returns Promise resolving an array of keys updated, `undefined` (immediately) if a noop.
-     */
-    set<K extends string>(key: K, value: Model.Value<this, K>, silent?: boolean): PromiseLike<Model.Event<this>[]> | undefined;
     /**
      * Call a function when update occurs.
      *
@@ -190,7 +209,7 @@ declare abstract class Model {
     set(status: null): void;
     /**
      * Iterate over managed properties in this instance of Model.
-     * Yeilds the key and underlying value for each property.
+     * Yeilds the key and current value for each property.
      */
     [Symbol.iterator](): Iterator<[string, unknown]>;
     /**
@@ -215,9 +234,10 @@ declare abstract class Model {
 }
 
 declare namespace get {
-    type Function<T, S = any> = (on: S, key: string) => T;
+    type Compute<T, S = any> = (on: S, key: string) => T;
     type Factory<T, S = any> = (this: S, key: string, thisArg: S) => T;
     type Source<T extends Model = Model> = (resolve: (x: T) => void) => void;
+    type Effect<T> = (model: T, key: string) => (() => void) | void;
 }
 /**
  * Fetches and assigns the controller which spawned this host.
@@ -244,14 +264,14 @@ declare function get<T extends Model>(Type: Model.Type<T>, required?: false): T
  * @param source - Type of Model to fetch for computation.
  * @param compute - Compute function. Will update automatically as input values change.
  */
-declare function get<R, T extends Model>(Type: Model.Type<T>, compute: get.Function<R, T>): R;
+declare function get<T extends Model>(Type: Model.Type<T>, effect: get.Effect<T>): T;
 /**
  * Implement a computed value; output will be generated by provided function.
  *
  * @param source - Source model from which computed value will be a subscriber.
  * @param compute - Compute function. Bound to a subscriber-proxy of source, returns output value. Will update automatically as input values change.
  */
-declare function get<R, T extends Model>(source: T, compute: get.Function<R, T>): R;
+declare function get<R, T extends Model>(source: T, compute: get.Compute<R, T>): R;
 /**
  * Implement a computed value; output is returned by function from provided factory.
  *
@@ -367,33 +387,6 @@ declare namespace has {
 declare function has<T extends Model>(type: Model.Type<T>, callback?: has.Callback<T>): readonly T[];
 declare function has(callback?: has.Callback): readonly Model[];
 
-/**
- * Update callback function.
- *
- * @param key -
- *   - `string` - property which has updated.
- *   - `false` - a normal update has completed.
- *   - `true` - initial event; instance is ready.
- *   - `null` - terminal event; instance is expired.
- * @param source - Instance of Model for which update has occured.
- */
-type OnUpdate<T = any> = (this: T, key: unknown, source: T) => (() => void) | null | void;
-type OnAccess<T, R = unknown> = (from: T, key: string | number, value: R) => unknown;
-type Event = number | string | null | boolean | symbol;
-declare function addListener(subject: {}, callback: OnUpdate, select?: Event): () => boolean;
-declare function createProxy<T extends {}>(from: T, observer: OnAccess<T>): any;
-type Effect<T extends {}> = (this: T, argument: T) => ((update: boolean | null) => void) | Promise<void> | null | void;
-/**
- * Create a side-effect which will update whenever values accessed change.
- * Callback is called immediately and if ever values are stale.
- *
- * @param target - Instance of Model to observe.
- * @param callback - Function to invoke when values change.
- * @param requireValues - If `true` will throw if accessing a value which is `undefined`.
- */
-declare function createEffect<T extends {}>(target: T, callback: Effect<Required<T>>, requireValues: true): () => void;
-declare function createEffect<T extends {}>(target: T, callback: Effect<T>, requireValues?: boolean): () => void;
-
 declare namespace Context {
     type Multiple<T extends Model> = {
         [key: string | number]: Model.Init<T> | T;