yahoo-finance2 - npm Package Compare versions

Comparing version 1.12.1 to 1.13.0

CHANGELOG.md

@@ -0,1 +1,8 @@
+# [1.13.0](https://github.com/gadicc/node-yahoo-finance2/compare/v1.12.1...v1.13.0) (2021-06-06)
+
+
+### Features
+
+* **errors:** expose in yf.errors; improve docs ([#202](https://github.com/gadicc/node-yahoo-finance2/issues/202)) ([a3a7da6](https://github.com/gadicc/node-yahoo-finance2/commit/a3a7da60b2775063450dc4a2fea5d607df7a4cea))
+
 ## [1.12.1](https://github.com/gadicc/node-yahoo-finance2/compare/v1.12.0...v1.12.1) (2021-06-03)
@@ -2,0 +9,0 @@

dist/cjs/package.json

 {
     "name": "yahoo-finance2",
-    "version": "1.12.1",
+    "version": "1.13.0",
     "description": "JS API for Yahoo Finance",
@@ -77,3 +77,3 @@ "type:": "commonjs",
         "@typescript-eslint/parser": "4.26.0",
-        "eslint": "7.27.0",
+        "eslint": "7.28.0",
         "eslint-config-prettier": "8.3.0",
@@ -84,3 +84,3 @@ "globby": "11.0.3",
         "oas-schema-walker": "1.1.5",
-        "prettier": "2.3.0",
+        "prettier": "2.3.1",
         "semantic-release": "17.4.3",
@@ -87,0 +87,0 @@ "ts-jest": "27.0.2",

dist/cjs/package.json.js

 module.exports = {
     "name": "yahoo-finance2",
-    "version": "1.12.1",
+    "version": "1.13.0",
     "description": "JS API for Yahoo Finance",
@@ -77,3 +77,3 @@ "type:": "commonjs",
         "@typescript-eslint/parser": "4.26.0",
-        "eslint": "7.27.0",
+        "eslint": "7.28.0",
         "eslint-config-prettier": "8.3.0",
@@ -84,3 +84,3 @@ "globby": "11.0.3",
         "oas-schema-walker": "1.1.5",
-        "prettier": "2.3.0",
+        "prettier": "2.3.1",
         "semantic-release": "17.4.3",
@@ -87,0 +87,0 @@ "ts-jest": "27.0.2",

dist/cjs/src/index-common.d.ts

@@ -18,2 +18,5 @@ import yahooFinanceFetch from "./lib/yahooFinanceFetch.js";
     _opts: import("./lib/options.js").YahooFinanceOptions;
+    errors: {
+        [key: string]: any;
+    };
     autoc: typeof autoc;
@@ -20,0 +23,0 @@ historical: typeof historical;

dist/cjs/src/index-common.js

@@ -10,2 +10,3 @@ "use strict";
 const options_js_1 = __importDefault(require("./lib/options.js"));
+const errors_js_1 = __importDefault(require("./lib/errors.js"));
 // modules
@@ -29,2 +30,4 @@ const autoc_js_1 = __importDefault(require("./modules/autoc.js"));
     _opts: options_js_1.default,
+    // errors
+    errors: errors_js_1.default,
     // modules,
@@ -31,0 +34,0 @@ autoc: autoc_js_1.default,

dist/cjs/src/lib/errors.d.ts

@@ -23,6 +23,6 @@ import type { ErrorObject } from "ajv/dist/types";
 }
-interface ErrorsIndex {
+declare type ErrorsIndex = {
     [key: string]: any;
-}
-declare const _default: ErrorsIndex;
-export default _default;
+};
+declare const errors: ErrorsIndex;
+export default errors;

dist/cjs/src/lib/errors.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FailedYahooValidationError = exports.NoEnvironmentError = exports.InvalidOptionsError = exports.HTTPError = exports.BadRequestError = void 0;
+// Yahoo's servers returned an HTTP 400 for this request.
 class BadRequestError extends Error {
@@ -11,2 +12,4 @@ constructor() {
 exports.BadRequestError = BadRequestError;
+// Yahoo's servers returned a 'not-ok' status for this request.
+// https://developer.mozilla.org/en-US/docs/Web/API/Response/ok
 class HTTPError extends Error {
@@ -19,2 +22,3 @@ constructor() {
 exports.HTTPError = HTTPError;
+// A YahooFinance method was called with invalid options.
 class InvalidOptionsError extends Error {
@@ -27,2 +31,3 @@ constructor() {
 exports.InvalidOptionsError = InvalidOptionsError;
+// An internal method yahooFinanceFetch() was called without this._env set.
 class NoEnvironmentError extends Error {
@@ -44,3 +49,3 @@ constructor() {
 exports.FailedYahooValidationError = FailedYahooValidationError;
-exports.default = {
+const errors = {
     BadRequestError,
@@ -52,1 +57,2 @@ HTTPError,
 };
+exports.default = errors;

dist/esm/package.json

 {
     "name": "yahoo-finance2",
-    "version": "1.12.1",
+    "version": "1.13.0",
     "description": "JS API for Yahoo Finance",
@@ -77,3 +77,3 @@ "type": "module",
         "@typescript-eslint/parser": "4.26.0",
-        "eslint": "7.27.0",
+        "eslint": "7.28.0",
         "eslint-config-prettier": "8.3.0",
@@ -84,3 +84,3 @@ "globby": "11.0.3",
         "oas-schema-walker": "1.1.5",
-        "prettier": "2.3.0",
+        "prettier": "2.3.1",
         "semantic-release": "17.4.3",
@@ -87,0 +87,0 @@ "ts-jest": "27.0.2",

dist/esm/package.json.js

 export default {
     "name": "yahoo-finance2",
-    "version": "1.12.1",
+    "version": "1.13.0",
     "description": "JS API for Yahoo Finance",
@@ -77,3 +77,3 @@ "type": "module",
         "@typescript-eslint/parser": "4.26.0",
-        "eslint": "7.27.0",
+        "eslint": "7.28.0",
         "eslint-config-prettier": "8.3.0",
@@ -84,3 +84,3 @@ "globby": "11.0.3",
         "oas-schema-walker": "1.1.5",
-        "prettier": "2.3.0",
+        "prettier": "2.3.1",
         "semantic-release": "17.4.3",
@@ -87,0 +87,0 @@ "ts-jest": "27.0.2",

dist/esm/src/index-common.d.ts

@@ -18,2 +18,5 @@ import yahooFinanceFetch from "./lib/yahooFinanceFetch.js";
     _opts: import("./lib/options.js").YahooFinanceOptions;
+    errors: {
+        [key: string]: any;
+    };
     autoc: typeof autoc;
@@ -20,0 +23,0 @@ historical: typeof historical;

dist/esm/src/index-common.js

@@ -5,2 +5,3 @@ // libs
 import options from "./lib/options.js";
+import errors from "./lib/errors.js";
 // modules
@@ -24,2 +25,4 @@ import autoc from "./modules/autoc.js";
     _opts: options,
+    // errors
+    errors,
     // modules,
@@ -26,0 +29,0 @@ autoc,

dist/esm/src/lib/errors.d.ts

@@ -23,6 +23,6 @@ import type { ErrorObject } from "ajv/dist/types";
 }
-interface ErrorsIndex {
+declare type ErrorsIndex = {
     [key: string]: any;
-}
-declare const _default: ErrorsIndex;
-export default _default;
+};
+declare const errors: ErrorsIndex;
+export default errors;

dist/esm/src/lib/errors.js

@@ -0,1 +1,2 @@
+// Yahoo's servers returned an HTTP 400 for this request.
 export class BadRequestError extends Error {
@@ -7,2 +8,4 @@ constructor() {
 }
+// Yahoo's servers returned a 'not-ok' status for this request.
+// https://developer.mozilla.org/en-US/docs/Web/API/Response/ok
 export class HTTPError extends Error {
@@ -14,2 +17,3 @@ constructor() {
 }
+// A YahooFinance method was called with invalid options.
 export class InvalidOptionsError extends Error {
@@ -21,2 +25,3 @@ constructor() {
 }
+// An internal method yahooFinanceFetch() was called without this._env set.
 export class NoEnvironmentError extends Error {
@@ -36,3 +41,3 @@ constructor() {
 }
-export default {
+const errors = {
     BadRequestError,
@@ -44,1 +49,2 @@ HTTPError,
 };
+export default errors;

package.json

 {
   "name": "yahoo-finance2",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "JS API for Yahoo Finance",
@@ -77,3 +77,3 @@ "type": "module",
     "@typescript-eslint/parser": "4.26.0",
-    "eslint": "7.27.0",
+    "eslint": "7.28.0",
     "eslint-config-prettier": "8.3.0",
@@ -84,3 +84,3 @@ "globby": "11.0.3",
     "oas-schema-walker": "1.1.5",
-    "prettier": "2.3.0",
+    "prettier": "2.3.1",
     "semantic-release": "17.4.3",
@@ -87,0 +87,0 @@ "ts-jest": "27.0.2",

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

Improved metrics

Total package byte prevSize

1239837

increased by0.1%

Lines of code

38611

increased by0.06%

No dependency changes