feedme - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

lib/feedme.js

@@ -1,4 +0,4 @@
-var EventYoshi = require('eventyoshi');
-var XMLFeedParser = require('./xmlfeedparser');
-var JSONFeedParser = require('./jsonfeedparser');
+const EventYoshi     = require('eventyoshi');
+const XMLFeedParser  = require('./xmlfeedparser');
+const JSONFeedParser = require('./jsonfeedparser');
 
@@ -9,5 +9,5 @@
  *
- * @param (Boolean) buffer If true, feed will be buffered into memory
- *   and can be retrieved using `parser.end()` on end.
- * @returns (Stream)
+ * @param {Boolean} buffer If true, feed will be buffered into memory
+ *   and can be retrieved using `parser.done()` on the `end` event.
+ * @returns {Stream}
  */
@@ -22,12 +22,9 @@ module.exports = function(buffer) {
   // First find out what type of feed this is.
-  yoshi.write = function(data) {
+  yoshi.write = (data) => {
     var str = data.toString();
-    var startParsing = false;
 
     if (/^\s*</.test(str)) {
-      startParsing = true;
       parser = XMLFeedParser(buffer);
 
-    } else if (/^\s*[\{\[]/.test(str)) {
-      startParsing = true;
+    } else if (/^\s*[{[]/.test(str)) {
       parser = JSONFeedParser(buffer);
@@ -40,3 +37,3 @@ yoshi.emit('type', 'json');
 
-    if (startParsing) {
+    if (parser) {
       yoshi.add(parser);
@@ -50,3 +47,3 @@ yoshi.proxy('write', 'end', 'done', 'close');
   // In case `end()` is called right away.
-  yoshi.end = function(data) {
+  yoshi.end = (data) => {
     if (data && data.length) {
@@ -53,0 +50,0 @@ yoshi.write(data);

lib/jsonfeedparser.js

@@ -1,2 +0,2 @@
-var clarinet = require('clarinet');
+const clarinet = require('clarinet');
 
@@ -9,4 +9,4 @@ /**
  *
- * @param (Object)
- * @returns (Object)
+ * @param {Object}
+ * @returns {Object}
  */
@@ -31,6 +31,6 @@ function cleanObject(obj) {
  *
- * @param (Boolean) buffer If true, will buffer entire object.
- * @return (clarinet.Stream)
+ * @param {Boolean} buffer If true, will buffer entire object.
+ * @return {clarinet.Stream}
  */
-module.exports = function(buffer) {
+module.exports = (buffer) => {
   var parser = clarinet.createStream();
@@ -139,3 +139,3 @@
 
-  parser.done = function() {
+  parser.done = () => {
     if (!buffer) { return; }
@@ -142,0 +142,0 @@ var root = currObj[currKey];

lib/xmlfeedparser.js

@@ -1,2 +0,2 @@
-var sax = require('sax');
+const sax = require('sax');
 
@@ -8,4 +8,4 @@
  *
- * @param (Object) obj
- * @returns (Object)
+ * @param {Object} obj
+ * @returns {Object}
  */
@@ -15,3 +15,3 @@ function cleanObj(obj) {
   if (obj.text != null) {
-    // if this tag has text, trim it
+    // If this tag has text, trim it.
     obj.text = trimIndent(obj.text);
@@ -39,4 +39,4 @@
  *
- * @param (String) str
- * @returns (String)
+ * @param {String} str
+ * @returns {String}
  */
@@ -80,6 +80,6 @@ function trimIndent(str) {
  *
- * @param (Boolean) buffer If true, will buffer entire object.
- * @return (sax.Stream)
+ * @param {Boolean} buffer If true, will buffer entire object.
+ * @return {sax.Stream}
  */
-module.exports = function(buffer) {
+module.exports = (buffer) => {
   var parser = sax.createStream(false, { lowercasetags: true });
@@ -141,3 +141,3 @@
 
-    stack.push({ obj: obj, key: key, i: i });
+    stack.push({ obj, key, i });
     obj = i ? obj[key][i] : obj[key];
@@ -165,3 +165,3 @@ }
   // Returns entire document in object form.
-  parser.done = function() {
+  parser.done = () => {
     if (!buffer) { return; }
@@ -168,0 +168,0 @@ var items;

package.json

@@ -11,3 +11,3 @@ {
   ],
-  "version": "1.0.1",
+  "version": "1.1.0",
   "repository": {
@@ -30,13 +30,13 @@ "type": "git",
     "clarinet": "^0.11.0",
-    "eventyoshi": "^0.1.4",
+    "eventyoshi": "^0.2.0",
     "sax": "^1.0.0"
   },
   "devDependencies": {
-    "istanbul": "*",
-    "mocha": "*"
+    "istanbul": "^0.4.5",
+    "mocha": "^4.0.1"
   },
   "engines": {
-    "node": ">=0.12"
+    "node": ">=4"
   },
   "license": "MIT"
 }

README.md

@@ -13,12 +13,12 @@ # FeedMe.js
 
-```javascript
-var FeedMe = require('feedme');
-var http = require('http');
+```js
+const FeedMe = require('feedme');
+const http = require('http');
 
-http.get('http://www.npr.org/rss/rss.php?id=1001', function(res) {
+http.get('http://www.npr.org/rss/rss.php?id=1001', (res) => {
   var parser = new FeedMe();
-  parser.on('title', function(title) {
+  parser.on('title', (title) => {
     console.log('title of feed is', title);
   });
-  parser.on('item', function(item) {
+  parser.on('item', (item) => {
     console.log();
@@ -44,10 +44,10 @@ console.log('news:', item.title);
 
-```javascript
-var FeedMe = require('feedme');
-var http = require('http');
+```js
+const FeedMe = require('feedme');
+const http = require('http');
 
-http.get('https://nodejs.org/en/feed/blog.xml', function(res) {
+http.get('https://nodejs.org/en/feed/blog.xml', (res) => {
   var parser = new FeedMe(true);
   res.pipe(parser);
-  parser.on('end', function() {
+  parser.on('end', () => {
     console.log(parser.done());
@@ -60,3 +60,3 @@ });
 
-```javascript
+```js
 {
@@ -113,4 +113,4 @@ type: 'rss 2.0',
 
-```javascript
-parser.on('description', function(d) {
+```js
+parser.on('description', (d) => {
   // do something
@@ -131,5 +131,3 @@ });
 
-```bash
-npm install feedme
-```
+    npm install feedme
 
@@ -136,0 +134,0 @@

No alert changes

Worsened metrics

Total package byte prevSize

15507

decreased by-1.03%

Lines of code

322

decreased by-0.92%

Number of lines in readme file

140

decreased by-1.41%

Dependency changes

• + Addedeventyoshi@0.2.1(transitive)

• - Removedeventyoshi@0.1.9(transitive)

• Updatedeventyoshi@^0.2.0