fetch-observable - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "fetch-observable",
   "description": "Observable-based Fetch API",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "BSD-3-Clause",
@@ -6,0 +6,0 @@ "repository": {

README.md

@@ -1,10 +0,10 @@
-# fetchObservable
+# fetchObservable()
 
-Observable-based [Fetch API](https://github.com/whatwg/fetch) that automatically refreshes data.
+Observable-based [Fetch API](https://github.com/whatwg/fetch) that automatically refreshes data and notifies subscribers.
 
 ## Features
 
-- API similar to the standard Fetch API.
+- Uses the standard Fetch API.
 - Uses Observable syntax from [ES Observable proposal](https://github.com/zenparsing/es-observable).
-- Runs in Node and browsers.
+- Runs in Node and browsers. (BYO Promises though)
 
@@ -14,3 +14,2 @@ ## Installation
 ```bash
-	# For web or Node:
 	npm install --save fetch-observable
@@ -24,9 +23,11 @@ ```
 
-// Creates a single fetchObservable for one or multiple URLs.
+// Creates a single observable for one or multiple URLs.
 const liveFeed = fetchObservable(
 	"http://example.org/live-feed.json",
-	{refreshDelay (iteration) { return iteration * 1000; }}
+	{
+		refreshDelay: (iteration) => iteration * 1000 // <-- Callback or just integer ms.
+	}
 );
 
-// Subscribe-syntax like ES Observables.
+// Subscribe-syntax of ES Observables.
 const subscription1 = liveFeed.subscribe({
@@ -48,2 +49,5 @@ next (response) {
 subscription1.resubscribe(); // <-- Observable resumes on 1 subscription.
+
+liveFeed.pause(); // <-- Observable can be paused manually.
+liveFeed.resume();
 ````
@@ -50,0 +54,0 @@

src/lib/fetchObservable.js

@@ -0,1 +1,4 @@
+/**
+ * @copyright © 2015, Rick Wong. All rights reserved.
+ */
 import __fetch from "isomorphic-fetch";
@@ -2,0 +5,0 @@ import PausableObservable from "lib/PausableObservable";

src/lib/PausableObservable.js

@@ -0,1 +1,4 @@
+/**
+ * @copyright © 2015, Rick Wong. All rights reserved.
+ */
 import {Observable} from "lib/Observable";
@@ -2,0 +5,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

64670

increased by297.5%

Number of package files

10

increased by25%

Lines of code

1377

increased by248.61%

Number of lines in readme file

60

increased by7.14%

Worsened metrics

Number of medium supply chain risk alerts

4

increased by300%

No dependency changes