google-finance-quote 2.0.4 → 3.0.0

package/README.md

@@ -1,9 +1,14 @@
 # google-finance-quote
+
 Node Google Finance API wrapper for free.
 No API key is required!
 > Note: This results may vary by up to 20 minutes.
+> Note: `3.0.0 <= x` doesn't support proxies.
+
 ## Usage
+
 ### Get Started
+
 ```js
 const { Finance, symbols, currencyCodesSymbols, cryptoCurrencyCodesSymbols } = require("google-finance-quote");
 
@@ -12,15 +17,6 @@ console.log(currencyCodesSymbols); // Returns available currency codes symbols.
 console.log(cryptoCurrencyCodesSymbols); // Returns available crypto currency codes symbols.
 
 const finance = new Finance(); // You can use this: new Finance({ from 'USD', to: 'JPY' });
-// You can use http(s) proxies.
-/*
-const proxy = {
-  host: 'example.com',
-  port: 2000,
-  protocol: 'http'
-}
-const finance = new Finance({ proxy });
-*/
 
 finance
   .setFrom('USD');
@@ -30,21 +26,18 @@ finance
   console.log(await finance.quote()); // { success: true, rate: 150.94225699999998 }
 })();
 ```
-### Class
-<strong>Finance({ from?:string, to?:string, proxy?:object })</strong>
 
-### Functions
-- <strong>.setFrom(from: string)</strong>
-Set the parameter of from.
+### Class
 
-- <strong>.setTo(to: string)</strong>
-Set the parameter of to.
+- **Finance({ from?: string, to?: string })**
 
-- <strong>.getParam(): object</strong>
-Returns the current param.
+  - **.setFrom(from: string)**
+  Set the parameter of from.
+  - **.setTo(to: string)**
+  Set the parameter of to.
+  - **.getParam(): object**
+  Returns the current param.
+  - **.quote(amount?: number): Promise<{ success: boolean, rate: number }>**
+  Returns the converted amount based on the exchange rate.
 
-- <strong>.quote(amount?: number): Promise<{ success: boolean, rate: number }></strong>
-Returns the converted amount based on the exchange rate.
 > Note: If the current rate cannot be obtained due to rate limits or network errors, success: false is returned.
-## Get Support
-<a href="https://discord.gg/yKW8wWKCnS"><img src="https://discordapp.com/api/guilds/1005287561582878800/widget.png?style=banner4" alt="Discord Banner"/></a>

package/index.d.ts

@@ -1,28 +1,13 @@
 declare module 'google-finance-quote' {
-  /**
-   * @interface Proxy
-   * @description Interface for proxy parameters.
-   * @property {string} host - Proxy host name.
-   * @property {number | undefined} - Proxy port number.
-   * @property {'http' | 'https'} protocol - Proxy protocol type.
-   */
-  interface Proxy {
-    host: string;
-    port?: number,
-    protocol: 'http' | 'https';
-  }
-
   /**
    * @interface FinanceParams
    * @description Interface for Finance class constructor parameters.
    * @property {string} from - The original currency symbol.
    * @property {string} to - The desired currency symbol.
-   * @property {Proxy | undefined} proxy - Proxy options.
    */
   interface FinanceParams {
     from: string;
     to: string;
-    proxy?: Proxy;
   }
 
   /**

package/index.js

@@ -9,7 +9,6 @@ const symbols = require('./lib/symbols');
  * @param {Object} p - The param includes p.from and p.to.
  * @param {string} p.from - The original currency symbol.
  * @param {string} p.to - The desired currency symbol.
- * @param {object | undefined} p.proxy - Proxy options.
  */
 class Finance {
   constructor(p) {
@@ -30,21 +29,6 @@ class Finance {
         to: null
       };
     } else throw new Error('Invalid parameters.');
-
-    this.proxy = {};
-    if (typeof p?.proxy === 'object') {
-      if (
-        typeof p.proxy?.host === 'string' &&
-        (
-          p.proxy.protocol === 'http' ||
-          p.proxy.protocol === 'https'
-        )
-      ) {
-        this.proxy.host = p.proxy.host;
-        if (typeof p.proxy?.port === 'number') this.proxy.port = p.proxy.port;
-        this.proxy.protocol = p.proxy.protocol;
-      }
-    }
   }
 
   /**
@@ -96,25 +80,7 @@ class Finance {
 
       const url = `${API_URL}${from}-${to}`;
 
-      let response;
-      if (this.proxy) {
-        const axiosConfig = {};
-        if (this.proxy.protocol === 'http') {
-          axiosConfig.proxy = {
-            host: this.proxy.host,
-          }
-          if (this.proxy.port) axiosConfig.proxy.port = this.proxy.port;
-        } else if (this.proxy.protocol === 'https') {
-          const proxyUrl = `http://${this.proxy.host}${this.proxy.port ? `:${this.proxy.port}` : ''}`;
-          const agent = new HttpsProxyAgent(proxyUrl);
-          axiosConfig.httpsAgent = agent;
-          axiosConfig.proxy = false;
-        }
-        response = await axios.get(url, axiosConfig);
-      } else {
-        response = await axios.get(url);
-      }
-
+      const response = await axios.get(url);
       const html = response.data;
       const startIndex =
         html.indexOf(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-finance-quote",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "Node Google Finance API wrapper for free. No API key is required!",
   "main": "index.js",
   "types": "index.d.ts",
@@ -24,8 +24,7 @@
     "codes",
     "data",
     "lib",
-    "free",
-    "proxy"
+    "free"
   ],
   "author": "otoneko.",
   "license": "ISC",
@@ -34,8 +33,7 @@
   },
   "homepage": "https://github.com/otoneko1102/google-finance-quote#readme",
   "dependencies": {
-    "axios": "^1.7.9",
-    "https-proxy-agent": "^7.0.6"
+    "axios": "^1.7.9"
   },
   "devDependencies": {
     "@types/node": "^22.13.2"