stock-info - npm Package Compare versions

Comparing version 1.5.0 to 1.5.1

package.json

 {
   "name": "stock-info",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Module to retrieve stock information from Yahoo Finance API",
+  "files": [
+    "dist"
+  ],
   "scripts": {
@@ -6,0 +9,0 @@ "test": "mocha",

README.md

 # stock-info
 
-The **Stock Info** library is exported as a CommonJS module.
-It retrieves current stock information from Yahoo Finance API.
+The **Stock Info** library retrieves current stock information from Yahoo Finance API.
 
@@ -9,2 +8,3 @@ ## Installation
 Using npm:
+
 ```shell
@@ -16,27 +16,49 @@ $ npm install --save stock-info
 
+```javascript
+import si from "stock-info";
+// or
+const si = require("stock-info");
+```
+
 ### getSingleStockInfo
+
 Retrieves information about a single stock symbol
+
 #### Input
+
 A string that represents a stock symbol
+
 #### Output
+
 A Promise that resolves to a stock objects
+
 #### Example
+
 ```js
-const si = require('stock-info');
-si.getSingleStockInfo('GOOG').then(console.log);
-//Outputs the result
+const si = require("stock-info");
+si.getSingleStockInfo("GOOG").then(console.log);
+//Prints the stock object to console
 ```
-  
+
 ### getStocksInfo
+
 Retrieves information about a list of stock symbols
+
+**Note:** This function will be removed in a future version. Just make your own list of promises using `getSingleStockInfo`.
+
 #### Input
+
 An array of strings where each element is a stock symbol.
+
 #### Output
+
 A Promise that resolves to an array of stock objects
+
 #### Example
+
 ```js
-const si = require('stock-info');
-const stocks = ['AMZN', 'NFLIX'];
+const si = require("stock-info");
+const stocks = ["AMZN", "NFLIX"];
 si.getStocksInfo(stocks).then(console.log);
-//Outputs the result
+//Prints an array of stock objects to console
 ```
@@ -120,60 +142,60 @@
 ```
-regularMarketPrice: 1065.545,  
-symbol: 'GOOG'  
-longName: 'Alphabet Inc.',  
-language: 'en-US',  
-quoteType: 'EQUITY',  
-quoteSourceName: 'Nasdaq Real Time Price',  
-currency: 'USD',  
-regularMarketTime: 1527603620,  
-regularMarketChange: -10.11499,  
-regularMarketOpen: 1064.89,  
-regularMarketDayHigh: 1072.99,  
-regularMarketDayLow: 1065,  
-regularMarketVolume: 322473,  
-trailingPE: 59.210102,  
-epsTrailingTwelveMonths: 17.996,  
-epsForward: 47.32,  
-market: 'us_market',  
-bidSize: 8,  
-askSize: 13,  
-messageBoardId: 'finmb_29096',  
-fullExchangeName: 'NasdaqGS',  
-financialCurrency: 'USD',  
-sharesOutstanding: 348952000,  
-bookValue: 219.496,  
-fiftyDayAverage: 1056.5917,  
-fiftyDayAverageChange: 8.953369,  
-fiftyDayAverageChangePercent: 0.008473821,  
-twoHundredDayAverage: 1071.8778,  
-twoHundredDayAverageChange: -6.3327637,  
-twoHundredDayAverageChangePercent: -0.0059081023,  
-marketCap: 741920931840,  
-forwardPE: 22.517859,  
-priceToBook: 4.854508,  
-sourceInterval: 15,  
-exchangeTimezoneName: 'America/New_York',  
-exchangeTimezoneShortName: 'EDT',  
-gmtOffSetMilliseconds: -14400000,  
-exchangeDataDelayedBy: 0,  
-marketState: 'REGULAR',  
-exchange: 'NMS',  
-priceHint: 2,  
-**shortName**: 'Alphabet Inc.',  
-regularMarketChangePercent: -0.94035196,  
-regularMarketDayRange: '1065.0 - 1072.99',  
-regularMarketPreviousClose: 1075.66,  
-bid: 1068.35,  
-ask: 1069,  
-averageDailyVolume3Month: 1849285,  
-averageDailyVolume10Day: 957300,  
-fiftyTwoWeekLowChange: 170.75507,  
-fiftyTwoWeekLowChangePercent: 0.19083257,  
-fiftyTwoWeekRange: '894.79 - 1186.89',  
-fiftyTwoWeekHighChange: -121.34497,  
-fiftyTwoWeekHighChangePercent: -0.10223775,  
-fiftyTwoWeekLow: 894.79,  
-fiftyTwoWeekHigh: 1186.89,  
-esgPopulated: false,  
-tradeable: true,  
-```
+regularMarketPrice: 1065.545,
+symbol: 'GOOG'
+longName: 'Alphabet Inc.',
+language: 'en-US',
+quoteType: 'EQUITY',
+quoteSourceName: 'Nasdaq Real Time Price',
+currency: 'USD',
+regularMarketTime: 1527603620,
+regularMarketChange: -10.11499,
+regularMarketOpen: 1064.89,
+regularMarketDayHigh: 1072.99,
+regularMarketDayLow: 1065,
+regularMarketVolume: 322473,
+trailingPE: 59.210102,
+epsTrailingTwelveMonths: 17.996,
+epsForward: 47.32,
+market: 'us_market',
+bidSize: 8,
+askSize: 13,
+messageBoardId: 'finmb_29096',
+fullExchangeName: 'NasdaqGS',
+financialCurrency: 'USD',
+sharesOutstanding: 348952000,
+bookValue: 219.496,
+fiftyDayAverage: 1056.5917,
+fiftyDayAverageChange: 8.953369,
+fiftyDayAverageChangePercent: 0.008473821,
+twoHundredDayAverage: 1071.8778,
+twoHundredDayAverageChange: -6.3327637,
+twoHundredDayAverageChangePercent: -0.0059081023,
+marketCap: 741920931840,
+forwardPE: 22.517859,
+priceToBook: 4.854508,
+sourceInterval: 15,
+exchangeTimezoneName: 'America/New_York',
+exchangeTimezoneShortName: 'EDT',
+gmtOffSetMilliseconds: -14400000,
+exchangeDataDelayedBy: 0,
+marketState: 'REGULAR',
+exchange: 'NMS',
+priceHint: 2,
+**shortName**: 'Alphabet Inc.',
+regularMarketChangePercent: -0.94035196,
+regularMarketDayRange: '1065.0 - 1072.99',
+regularMarketPreviousClose: 1075.66,
+bid: 1068.35,
+ask: 1069,
+averageDailyVolume3Month: 1849285,
+averageDailyVolume10Day: 957300,
+fiftyTwoWeekLowChange: 170.75507,
+fiftyTwoWeekLowChangePercent: 0.19083257,
+fiftyTwoWeekRange: '894.79 - 1186.89',
+fiftyTwoWeekHighChange: -121.34497,
+fiftyTwoWeekHighChangePercent: -0.10223775,
+fiftyTwoWeekLow: 894.79,
+fiftyTwoWeekHigh: 1186.89,
+esgPopulated: false,
+tradeable: true,
+```

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

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

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

5

decreased by-16.67%

Number of lines in readme file

199

increased by13.07%

Worsened metrics

Total package byte prevSize

22219

decreased by-25.35%

Number of package files

11

decreased by-38.89%

Lines of code

20

decreased by-88.7%

No dependency changes