@reactive-js/scheduler - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

package.json

 {
   "name": "@reactive-js/scheduler",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "main": "dist/cjs/index.js",
@@ -8,3 +8,24 @@ "module": "dist/esm5/index.js",
   "keywords": [
-    "rx"
+    "asynchronous",
+    "data flow",
+    "data-flow",
+    "frp",
+    "functional programming",
+    "functional-reactive-programming",
+    "ix",
+    "observable",
+    "observables",
+    "react",
+    "reactjs",
+    "reactive",
+    "reactive-extensions",
+    "reactive-js",
+    "reactive-x",
+    "rx",
+    "rxjs",
+    "scheduler",
+    "state management",
+    "state-management",
+    "stream",
+    "streams"
   ],
@@ -21,4 +42,3 @@ "author": {
   "dependencies": {
-    "@reactive-js/disposable": "^0.0.4",
-    "tslib": "^1.10.0"
+    "@reactive-js/disposable": "^0.0.5"
   },
@@ -35,3 +55,3 @@ "scripts": {
   },
-  "gitHead": "482ada60e92db42bf0632396fcde4bc836585e8b"
+  "gitHead": "1a8f6684d73e5529349956ced1b9f29241896d8e"
 }

README.md

 # @reactive-js/scheduler
 
-Abstract API for cooperative scheduling.
+Abstract API for a cooperative multi-tasking scheduler in a javascript environment. 
+
+The Scheduler API is designed to support both immediate and delayed scheduling of work, known as a SchedulerContinuation. Recursively scheduled work is also supported. Cooperative multi-tasking is achieved via periodic polling of the `shouldYield` function within a SchedulerContinuation.
+
+This abstract API is meant to be implemented by a platform specific implementation such as React's [Scheduler](https://github.com/facebook/react/tree/master/packages/scheduler) package. Such an implementation is available in the [@reactive-js/react-scheduler](https://www.npmjs.com/package/@reactive-js/react-scheduler) package.
+
+## Installation
+
+### via npm
+
+```sh
+npm install @reactive-js/scheduler
+```
+
+### via yarn
+
+```sh
+yarn add @reactive-js/scheduler
+```
+
+## Documentation
+
+API documentation is available [here](./docs).

No alert changes

Improved metrics

Total package byte prevSize

10247

increased by13.68%

Dependency count

1

decreased by-50%

Number of lines in readme file

25

increased by525%

Dependency changes

• + Added@reactive-js/disposable@0.0.5(transitive)

• - Removedtslib@^1.10.0

• - Removed@reactive-js/disposable@0.0.4(transitive)

• - Removedtslib@1.14.1(transitive)

• Updated@reactive-js/disposable@^0.0.5