@effectionx/raf 1.0.0-alpha.0 → 1.0.0-alpha.1

package/README.md

@@ -1,7 +1,8 @@
 # RAF: Request Animation Frame
 
-Subscribe to a stream of Request Animation Frame updates with an Effection
-resource.
+Subscribe to a stream of
+[Request Animation Frame](https://developer.mozilla.org/en-US/docs/Web/API/DedicatedWorkerGlobalScope/requestAnimationFrame)
+updates.
 
 ---
 
@@ -10,9 +11,9 @@ import { each, main, suspend } from "effection";
 import { raf } from "@effectionx/raf";
 
 await main(function* () {
-  for (const frame of yield* each(raf)) {
+  for (const timestamp of yield* each(raf)) {
     // add your handler code here
-    console.log(frame);
+    console.log(timestamp);
     yield* each.next();
   }
 });

package/esm/raf.d.ts

@@ -1,6 +1,6 @@
 import { type Stream } from "effection";
 /**
- * Consume RAF's as a Stream.
+ * A stream that produces animation frames.
  */
 export declare const raf: Stream<number, never>;
 //# sourceMappingURL=raf.d.ts.map

package/esm/raf.js

@@ -1,6 +1,6 @@
 import { createSignal, resource } from "effection";
 /**
- * Consume RAF's as a Stream.
+ * A stream that produces animation frames.
  */
 export const raf = resource(function* (provide) {
     let signal = createSignal();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effectionx/raf",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.1",
   "author": "engineering@frontside.com",
   "repository": {
     "type": "git",
@@ -18,9 +18,13 @@
       "require": "./script/mod.js"
     }
   },
+  "scripts": {},
   "engines": {
     "node": ">= 16"
   },
   "sideEffects": false,
+  "dependencies": {
+    "effection": "^3"
+  },
   "_generatedBy": "dnt@dev"
 }

package/script/raf.d.ts

@@ -1,6 +1,6 @@
 import { type Stream } from "effection";
 /**
- * Consume RAF's as a Stream.
+ * A stream that produces animation frames.
  */
 export declare const raf: Stream<number, never>;
 //# sourceMappingURL=raf.d.ts.map

package/script/raf.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.raf = void 0;
 const effection_1 = require("effection");
 /**
- * Consume RAF's as a Stream.
+ * A stream that produces animation frames.
  */
 exports.raf = (0, effection_1.resource)(function* (provide) {
     let signal = (0, effection_1.createSignal)();