Rename ‘resolved’ to ‘results’

Author: RoyalIcing

readme.md

@@ -37,7 +37,7 @@ function Loader() {
   // This is the ‘loading’ state
   function* loading() {
     // This function will be called when this state is entered.
-    // Its return value is available at `loader.resolved.fetchData`
+    // Its return value is available at `loader.results.fetchData`
     yield entry(fetchData);
     // If the promise succeeds, we will transition to the `success` state
     // If the promise fails, we will transition to the `failure` state
@@ -62,14 +62,14 @@ loader.current; // "idle"
 loader.next("FETCH");
 loader.current; // "loading"
 
-loader.resolved.then((result) => {
+loader.results.then((result) => {
   console.log("Fetched", result.fetchData);
   // Use response of fetch()
   loader.current; // "success"
 });
 
 /* Or with await: */
-// const { fetchData } = await loader.resolved;
+// const { fetchData } = await loader.results;
 // loader.current; // "success"
 ```
 
@@ -113,7 +113,7 @@ loader.current; // "idle"
 loader.next("FETCH");
 loader.current; // "loading"
 
-loader.resolved.then(([response]) => {
+loader.results.then(([response]) => {
   // Use response of fetch()
   loader.current; // "success"
 });

src/index.test.ts

@@ -63,7 +63,7 @@ describe("Machine with entry and exit actions", () => {
       expect(loader.changeCount).toEqual(1);
       expect(finishedLoading).toHaveBeenCalledTimes(0);
 
-      await expect(loader.resolved).resolves.toEqual({ fetchData: 42 });
+      await expect(loader.results).resolves.toEqual({ fetchData: 42 });
       await expect(Promise.resolve(transitionResult)).resolves.toEqual({ fetchData: 42 });
       expect(finishedLoading).toHaveBeenCalledTimes(1);
       expect(loader.changeCount).toEqual(2);
@@ -76,7 +76,7 @@ describe("Machine with entry and exit actions", () => {
       expect(loader.current).toEqual("success");
       expect(succeeded).toHaveBeenCalledTimes(1);
 
-      await loader.resolved;
+      await loader.results;
     });
   });
 
@@ -98,7 +98,7 @@ describe("Machine with entry and exit actions", () => {
       expect(loader.current).toEqual("loading");
       expect(loader.changeCount).toEqual(1);
 
-      await expect(loader.resolved).rejects.toEqual(new Error("Failed!"));
+      await expect(loader.results).rejects.toEqual(new Error("Failed!"));
       await expect(Promise.resolve(transitionResult)).rejects.toEqual(
         new Error("Failed!")
       );
@@ -116,7 +116,7 @@ describe("Machine with entry and exit actions", () => {
       expect(fetch).toHaveBeenCalledTimes(2);
       expect(fetch).toHaveBeenLastCalledWith("https://example.org/");
 
-      await expect(loader.resolved).resolves.toEqual({ fetchData: 42 });
+      await expect(loader.results).resolves.toEqual({ fetchData: 42 });
       expect(loader.changeCount).toEqual(4);
       expect(loader.current).toEqual("success");
     });

src/index.ts

@@ -74,7 +74,7 @@ export function compound(...targets: Array<StateDefinition>): Compound {
 export interface MachineInstance extends Iterator<null | string | Record<string, string>, void, string> {
   changeCount: number;
   current: null | string | Record<string, string>;
-  resolved: null | Promise<Array<any>>;
+  results: null | Promise<Array<any>>;
   done: boolean;
   next(
     ...args: [string]
@@ -204,7 +204,7 @@ class InternalInstance {
     }
   }
 
-  get value(): Promise<Array<any>> {
+  get results(): Promise<Array<any>> {
     const build = async () => {
       const objects: Array<any> = [];
       for await (const object of this.valuePromises()) {
@@ -365,12 +365,12 @@ export function start(
     get current() {
       return instance.current !== null ? instance.current[rootName] : null;
     },
-    get resolved() {
-      return instance.value;
+    get results() {
+      return instance.results;
     },
     next(event: string) {
       instance.receive(event);
-      const promise = instance.value;
+      const promise = instance.results;
       return {
         value: instance.current !== null ? instance.current[rootName] : null,
         actions: instance.actions,