From 0cbee3da1d1b3fcbc4837b166a0aa4fcd767cab5 Mon Sep 17 00:00:00 2001
From: Dean Radcliffe <24406+deanrad@users.noreply.github.com>
Date: Sat, 20 Jan 2024 18:15:08 -0600
Subject: [PATCH] rxfx/effect 1.0.1 README

---
 effect/README.md    | 167 +++++++++++++++++++++++++++++++++++++++++++-
 effect/package.json |   2 +-
 2 files changed, 167 insertions(+), 2 deletions(-)

diff --git a/effect/README.md b/effect/README.md
index 41e803f..33c139a 100644
--- a/effect/README.md
+++ b/effect/README.md
@@ -2,4 +2,169 @@
 
 A Vanilla JS container for Effect Management, based on RxJS. Supports cancelation, concurrency modes (queueing, throttling, debouncing), and TypeScript.
 
-Part of the [𝗥𝘅𝑓𝑥](https://github.com/deanrad/rxfx) family of libraries.
\ No newline at end of file
+Part of the [𝗥𝘅𝑓𝑥](https://github.com/deanrad/rxfx) family of libraries.
+
+# What Is It Good For?
+
+When you have an async effect, embodied in a function that returns a Promise or an Observable, but you want it to:
+
+- not run too often
+- be cancelable
+- automatically track whether it is active
+
+# Usage
+
+Treat `createEffect` (or a concurrency-controlled version like `createQueueingEffect`) as a higher-order function which returns a concurrency-controlled, cancelable version of that function
+
+```
+npm i -S @rxfx/effect
+```
+
+```ts
+import { createEffect, createQueueingEffect } from '@rxfx/effect';
+
+const ringBell = () => {
+  /* returns a Promise for when a bell has completed ringing */
+};
+
+// The RxFx effect with no concurrency control
+const ringEffect = createEffect(ringBell);
+// An RxFx effect that queues ringing, with the same API as createEffect
+const queuedRing = createQueueingEffect(ringBell);
+
+queuedRing(); // ring it now
+queuedRing(); // ring after the first
+queuedRing.request(); // alternate way to ring
+
+queuedRing.cancelCurrent();          // cancels this ring, begins the next 
+queuedRing.cancelCurrentAndQueued(); // cancels this ring, empties the queue
+
+// Query if active now, or subscribe to all activity updates
+queuedRing.isActive.value
+queuedRing.isActive.subscribe
+
+// The current error (cleared when a new execution begins), or all errors
+queuedRing.currentError.value
+queuedRing.errors.subscribe
+
+// See @rxfx/service for more
+```
+
+# Usage in React
+
+The `useService` hook from `@rxfx/react` brings the current `isActive` status and `currentError` into React.
+
+```ts
+function BellComponent() {
+  const { isActive, currentError } = useService(queuedRing);
+  // render 🛎️ if active
+}
+```
+
+# Usage in Angular
+
+```ts
+import { queuedRing } from '../services/ringer'
+
+export class BellComponent {
+  isActive$: Observable<boolean>;
+
+  constructor() {
+    this.isActive$ = queuedRing.isActive;
+  }
+
+  ring() {
+    queuedRing();
+  }
+
+}
+
+// html
+<button (click)="ring()">
+<div>busy: {{ isActive$ | async }}</div>
+
+```
+
+
+# Relation to `@rxfx/bus` and `@rxfx/service`
+Every effect returned by `createEffect` or its variants is an instance of an `@rxfx/service`. You might use `@rxfx/effect` when you only care about the effect in a concurrency-controlled and cancelable fashion, and are not tracking its state.
+
+
+Compared to creating a service, when you create an effect, you omit the parameters `name`, `bus`, and `reducer`, so RxFx fills them in as shown:
+
+- Name: A randomly assigned ID
+- Bus: The `defaultBus` as exposed by `@rxfx/service`
+- Reducer: A default reducer whose state is always the most recent response (though if you are interested in state, you probably are using `createService` not `createEffect`)
+
+All the effect's lifecycle events (`request`, `started`, `next`, `complete`, `error`, `cancel`, `canceled`) go on its bus, and can be logged to the console with `bus.spy`, though the names of the events will have the random name assigned:
+
+```
+// bus.spy(({type}) => console.log(type));
+aed123/request
+aed123/next
+aed123/complete
+```
+
+If `bus.reset()` is called, all existing effects will stop responding to requests, and if their executions are cancelable, those will be canceled too.
+
+# Errors
+
+If the effect function returns a rejected Promise, throws an exception, or returns an Observable which emits an error, there is no risk to your app as a whole. The error goes onto the bus as a regular event, and you can respond to them or log them via the `.errors` Observable.
+
+```ts
+// See errors in the console
+queuedRing.errors.subscribe(console.error)
+```
+
+# Cancelability
+Since Promises are not generally cancelable, the primary way to create a cancelable effect is to make it from a function that returns an Observable.
+
+Otherwise, if your effect's Promise can abort on an `AbortSignal`, use `makeAbortableHandler` in `@rxfx/ajax`. [Specs](https://github.com/deanrad/rxfx/blob/main/ajax/test/makeAbortableHandler.spec.ts)
+
+# Couldn't I use plain RxJS?
+
+To implement a queued bell ringer with raw RxJS you'd trigger it from a `Subject`, create an `Observable` with a pipe, and call `subscribe` on it:
+
+```ts
+import { Subject } from 'rxjs'
+import { concatMap } from 'rxjs/operators'
+
+const ringer = new Subject();
+ringer.pipe(
+  concatMap(ringBell)
+).subscribe();
+
+ringer.next() // immediate 1st ring
+ringer.next() // queued 2nd ring
+```
+
+But this would not allow cancelation of the current ring! To add cancelation you need more imports and another `Subject`
+
+```ts
+import { Subject } from 'rxjs'
+import { concatMap, takeUntil } from 'rxjs/operators'
+
+const cancels = new Subject();
+const ringer = new Subject();
+
+const bellEffect = ringer.pipe(
+  concatMap(() => {
+    return defer(ring).pipe(
+      takeUntil(cancels)
+    )
+  })
+).subscribe()
+
+ringer.next() // immediate 1st ring
+ringer.next() // queued 2nd ring
+```
+
+So it works, but the happy path is very obscured, and it would take quite a lot of mastery of RxJS to read or write that code. (Also this version doesn't even handle `cancelCurrentAndQueued`).
+
+In short — while you _could_ use raw RxJS, all the awkwardness of it goes away when you use an 𝗥𝘅𝑓𝑥 service or an effect.
+
+- No calls to `subscribe`
+- Fewer imports
+- No awkward `pipe`s.
+
+So stop fighting the tools, and climb up a level of abstraction - it's nice up here!
\ No newline at end of file
diff --git a/effect/package.json b/effect/package.json
index a26ff0e..4b4fc97 100644
--- a/effect/package.json
+++ b/effect/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rxfx/effect",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "MIT",
   "author": "Dean Radcliffe",
   "repository": "https://github.com/deanrad/rxfx",