@manyducks.co/dolla 0.69.2 → 0.69.4

package/notes/state.md

@@ -1,71 +0,0 @@
-# State
-
-I want to update the state API to be a single constructor object, similar to built-ins like `Math` and `Array`. The current API has a lot of separate functions that work together in various ways, but I feel it would be easier to explain and understand if these functions were under one namespace.
-
-Current API:
-
-```ts
-import { readable, writable, computed, unwrap, proxy, type Readable, type Writable } from "@manyducks.co/dolla";
-
-const $$writable = writable({ someValue: 5, otherValue: "test" });
-const $readable = readable($$writable);
-const $computed = computed($$writable, (value) => value.someValue * 256);
-const unwrapped = unwrap($computed);
-const $$proxy = proxy($$writable, {
-  get(source) {
-    return source.get().someValue;
-  },
-  set(source, value) {
-    source.update((current) => {
-      return { ...current, someValue: value };
-    });
-  },
-});
-const $multiComputed = computed([$one, $$two, $three], ([one, two, three], [oldOne, oldTwo, oldThree]) => {
-  return one + two + three;
-});
-
-$$writable.get();
-$$writable.set({ someValue: 12, otherValue: null });
-$$writable.update((current) => ({ ...current, someValue: 100 }));
-
-$readable.get();
-```
-
-The main problem with the above is that we have two things (readable and writable) and a bunch of disconnected utility functions.
-
-Proposed API:
-
-```ts
-import { State, type Readable, type Writable } from "@manyducks.co/dolla";
-
-const $$writable = State.writable({ someValue: 5, otherValue: "test" }); // Longhand
-const $$writable = State({ someValue: 5, otherValue: "test" }); // Shorthand
-const $readable = State.readable($$writable);
-const $readable = $$writable.readable(); // Directly from a writable
-const $computed = State.from($$writable, (value) => value.someValue * 256);
-const unwrapped = State.unwrap($computed);
-const $$proxy = State.proxy($$writable, {
-  get(current) {
-    return current.someValue;
-  },
-  set(value, update) {
-    update((current) => {
-      return { ...current, someValue: value };
-    });
-  },
-});
-const $multiComputed = State.from($one, $$two, $three, (one, two, three, ctx) => {
-  // ctx.lastValues = [oldOne, oldTwo, oldThree];
-  // ctx.lastReturned = oldOne + oldTwo + oldThree
-  return one + two + three;
-});
-
-$$writable.get();
-$$writable.set({ someValue: 12, otherValue: null });
-$$writable.update((current) => ({ ...current, someValue: 100 }));
-
-$readable.get();
-```
-
-Now we have one state primitive (`State`), all instances of which implement `Readable` and some of which implement `Writable`. All utility functions are under the same namespace. This also avoids conflicts with Node streams' Readable and Writable which can be an issue with automatic imports.