feat: add cmd.ofNone function (#57)

Author: atheck

README.md

@@ -266,6 +266,7 @@ You can call one of the functions of that object:
 | `cmd.ofEither` | Calls a function (sync or async) and maps the result into a message. |
 | `cmd.ofSuccess` | Same as `ofEither` but ignores the error case. |
 | `cmd.ofError` | Same as `ofEither` but ignores the success case. |
+| `cmd.ofNone` | Same as `ofEither` but ignores both, the success case and the error case. |
 | `cmd.ofSub` | Use this function to trigger a command in a subscription. |
 
 ### Dispatch a message

src/cmd.spec.ts

@@ -283,4 +283,52 @@ describe("cmd", () => {
 			expect(message.name).toBe("error");
 		});
 	});
+
+	describe("ofNone", () => {
+		it("runs a sync task", () => {
+			// arrange
+			const task = jest.fn();
+			const result = cmd.ofNone(task);
+
+			// act
+			result[0]?.(() => null);
+
+			// assert
+			expect(task).toHaveBeenCalledTimes(1);
+		});
+
+		it("runs an async task", () => {
+			// arrange
+			const task = jest.fn(asyncResolve);
+			const result = cmd.ofNone(task);
+
+			// act
+			result[0]?.(() => null);
+
+			// assert
+			expect(task).toHaveBeenCalledTimes(1);
+		});
+
+		it("ignores the error for a sync task", async () => {
+			// arrange
+			const result = cmd.ofNone(syncError);
+
+			// act
+			const succeeds = (): void => result[0]?.(jest.fn());
+
+			// assert
+			expect(succeeds).not.toThrow();
+		});
+
+		it("ignores the error for an async task", async () => {
+			// arrange
+			const result = cmd.ofNone(asyncReject);
+
+			// act
+			const succeeds = (): void => result[0]?.(jest.fn());
+
+			// assert
+			expect(succeeds).not.toThrow();
+		});
+	});
 });

src/cmd.ts

@@ -108,6 +108,30 @@ const cmd = {
 
 		return [bind];
 	},
+
+	/**
+	 * Creates a command out of a function and ignores both, the success case and the error case. This can also be an async function.
+	 * @param task The function to call.
+	 * @param args The parameters of the task.
+	 */
+	ofNone<TErrorMessage extends Message, TArgs extends unknown[]>(
+		task: (...args: TArgs) => unknown,
+		...args: TArgs
+	): Cmd<TErrorMessage> {
+		const bind = (_dispatch: Dispatch<TErrorMessage>, fallback?: FallbackHandler): void => {
+			try {
+				const taskResult = task(...args);
+
+				Promise.resolve(taskResult)
+					.then(() => fallback?.())
+					.catch(() => fallback?.());
+			} catch {
+				fallback?.();
+			}
+		};
+
+		return [bind];
+	},
 };
 
 function defaultFallbackHandler(): void {