Rename ‘value’ to ‘current’

Author: RoyalIcing

readme.md

@@ -57,20 +57,20 @@ function Loader() {
 }
 
 const loader = start(Loader);
-loader.value; // "idle"
+loader.current; // "idle"
 
 loader.next("FETCH");
-loader.value; // "loading"
+loader.current; // "loading"
 
 loader.resolved.then((result) => {
   console.log("Fetched", result.fetchData);
   // Use response of fetch()
-  loader.value; // "success"
+  loader.current; // "success"
 });
 
 /* Or with await: */
 // const { fetchData } = await loader.resolved;
-// loader.value; // "success"
+// loader.current; // "success"
 ```
 
 ### Passing parameters to a machine with closures
@@ -108,14 +108,14 @@ function SpecificLoader() {
 
 // Start our specific loader machine
 const loader = start(SpecificLoader);
-loader.value; // "idle"
+loader.current; // "idle"
 
 loader.next("FETCH");
-loader.value; // "loading"
+loader.current; // "loading"
 
 loader.resolved.then(([response]) => {
   // Use response of fetch()
-  loader.value; // "success"
+  loader.current; // "success"
 });
 ```
 
@@ -125,6 +125,8 @@ loader.resolved.then(([response]) => {
 ## TODO
 
 - [ ] Parallel states by returning object for initial state
+- [ ] Assign data somehow?
+- [ ] Allow sending objects: `Event | { type: string }`
 - [ ] More examples!
 - [ ] Hook for React
 - [ ] Hook for Preact

src/index.test.ts

@@ -47,33 +47,33 @@ describe("Machine with entry and exit actions", () => {
 
     test("sending events", async () => {
       const loader = start(Loader);
-      expect(loader.value).toEqual("idle");
+      expect(loader.current).toEqual("idle");
       expect(loader.changeCount).toEqual(0);
 
       loader.next("NOOP");
-      expect(loader.value).toEqual("idle");
+      expect(loader.current).toEqual("idle");
       expect(loader.changeCount).toEqual(0);
 
       const transitionResult = loader.next("FETCH");
       expect(fetch).toHaveBeenCalledWith("https://example.org/");
       expect(transitionResult.actions).toEqual([
         { type: "entry", f: fetchData },
       ]);
-      expect(loader.value).toEqual("loading");
+      expect(loader.current).toEqual("loading");
       expect(loader.changeCount).toEqual(1);
       expect(finishedLoading).toHaveBeenCalledTimes(0);
 
       await expect(loader.resolved).resolves.toEqual({ fetchData: 42 });
       await expect(Promise.resolve(transitionResult)).resolves.toEqual({ fetchData: 42 });
       expect(finishedLoading).toHaveBeenCalledTimes(1);
       expect(loader.changeCount).toEqual(2);
-      expect(loader.value).toEqual("success");
+      expect(loader.current).toEqual("success");
       expect(succeeded).toHaveBeenCalledTimes(1);
 
       const transitionResult2 = loader.next("FETCH");
       // expect(transitionResult2.actions).toEqual([]);
       expect(loader.changeCount).toEqual(2);
-      expect(loader.value).toEqual("success");
+      expect(loader.current).toEqual("success");
       expect(succeeded).toHaveBeenCalledTimes(1);
 
       await loader.resolved;
@@ -87,38 +87,38 @@ describe("Machine with entry and exit actions", () => {
 
     test("sending events", async () => {
       const loader = start(Loader);
-      expect(loader.value).toEqual("idle");
+      expect(loader.current).toEqual("idle");
 
       const transitionResult = loader.next("FETCH");
       expect(fetch).toHaveBeenCalledTimes(1);
       expect(fetch).toHaveBeenLastCalledWith("https://example.org/");
       expect(transitionResult.actions).toEqual([
         { type: "entry", f: fetchData },
       ]);
-      expect(loader.value).toEqual("loading");
+      expect(loader.current).toEqual("loading");
       expect(loader.changeCount).toEqual(1);
 
       await expect(loader.resolved).rejects.toEqual(new Error("Failed!"));
       await expect(Promise.resolve(transitionResult)).rejects.toEqual(
         new Error("Failed!")
       );
       expect(loader.changeCount).toEqual(2);
-      expect(loader.value).toEqual("failure");
+      expect(loader.current).toEqual("failure");
 
       loader.next("FETCH");
       expect(fetch).toHaveBeenCalledTimes(1);
       expect(loader.changeCount).toEqual(2);
 
       loader.next("RETRY");
-      expect(loader.value).toEqual("loading");
+      expect(loader.current).toEqual("loading");
       expect(loader.changeCount).toEqual(3);
 
       expect(fetch).toHaveBeenCalledTimes(2);
       expect(fetch).toHaveBeenLastCalledWith("https://example.org/");
 
       await expect(loader.resolved).resolves.toEqual({ fetchData: 42 });
       expect(loader.changeCount).toEqual(4);
-      expect(loader.value).toEqual("success");
+      expect(loader.current).toEqual("success");
     });
   });
 });
@@ -157,18 +157,18 @@ describe("Form Field Machine with always()", () => {
     test("sending events", () => {
       const formField = start(FormField);
       expect(formField).toBeDefined();
-      expect(formField.value).toEqual("initial");
+      expect(formField.current).toEqual("initial");
 
       formField.next("CHANGE");
-      expect(formField.value).toEqual("editing");
+      expect(formField.current).toEqual("editing");
       expect(formField.changeCount).toEqual(1);
 
       formField.next("CHANGE");
-      expect(formField.value).toEqual("editing");
+      expect(formField.current).toEqual("editing");
       expect(formField.changeCount).toEqual(1);
 
       formField.next("BLUR");
-      expect(formField.value).toEqual("valid");
+      expect(formField.current).toEqual("valid");
       expect(formField.changeCount).toEqual(3);
     });
   });
@@ -181,18 +181,18 @@ describe("Form Field Machine with always()", () => {
     test("sending events", () => {
       const formField = start(FormField);
       expect(formField).toBeDefined();
-      expect(formField.value).toEqual("initial");
+      expect(formField.current).toEqual("initial");
 
       formField.next("CHANGE");
-      expect(formField.value).toEqual("editing");
+      expect(formField.current).toEqual("editing");
       expect(formField.changeCount).toEqual(1);
 
       formField.next("CHANGE");
-      expect(formField.value).toEqual("editing");
+      expect(formField.current).toEqual("editing");
       expect(formField.changeCount).toEqual(1);
 
       formField.next("BLUR");
-      expect(formField.value).toEqual("invalid");
+      expect(formField.current).toEqual("invalid");
       expect(formField.changeCount).toEqual(3);
     });
   });
@@ -240,28 +240,28 @@ describe("Hierarchical Traffic Lights Machine", () => {
   test("sending events", () => {
     const machine = start(TrafficLights);
     expect(machine).toBeDefined();
-    expect(machine.value).toEqual("green");
+    expect(machine.current).toEqual("green");
 
     machine.next("TIMER");
-    expect(machine.value).toEqual("yellow");
+    expect(machine.current).toEqual("yellow");
     expect(machine.changeCount).toEqual(1);
 
     machine.next("TIMER");
-    // expect(machine.value).toEqual("red");
-    // expect(machine.value).toEqual(["red", "walk"]);
-    expect(machine.value).toEqual({ "red": "walk" });
+    // expect(machine.current).toEqual("red");
+    // expect(machine.current).toEqual(["red", "walk"]);
+    expect(machine.current).toEqual({ "red": "walk" });
     expect(machine.changeCount).toEqual(3);
 
     machine.next("TIMER");
-    expect(machine.value).toEqual("green");
+    expect(machine.current).toEqual("green");
     expect(machine.changeCount).toEqual(4);
 
     machine.next("POWER_RESTORED");
-    expect(machine.value).toEqual({ "red": "walk" });
+    expect(machine.current).toEqual({ "red": "walk" });
     expect(machine.changeCount).toEqual(6);
 
     machine.next("POWER_OUTAGE");
-    expect(machine.value).toEqual({ "red": "blinking" });
+    expect(machine.current).toEqual({ "red": "blinking" });
     expect(machine.changeCount).toEqual(7);
   });
 });

src/index.ts

@@ -73,7 +73,7 @@ export function compound(...targets: Array<StateDefinition>): Compound {
 
 export interface MachineInstance extends Iterator<null | string | Record<string, string>, void, string> {
   changeCount: number;
-  value: null | string | Record<string, string>;
+  current: null | string | Record<string, string>;
   resolved: null | Promise<Array<any>>;
   done: boolean;
   next(
@@ -362,7 +362,7 @@ export function start(
     get changeCount() {
       return changeCount;
     },
-    get value() {
+    get current() {
       return instance.current !== null ? instance.current[rootName] : null;
     },
     get resolved() {