google-finance-quote 1.0.0 → 2.0.0

package/README.md

@@ -1,13 +1,15 @@
 # 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.
 ## Usage
 ### Get Started
 ```js
-const Finance = require("google-finance-quote");
+const { Finance, symbols } = require("google-finance-quote");
+
+console.log(symbols); // Returns available symbols.
 
-const finance = new Finance(); // You can use this: new Finance({ from 'usd', to: 'jpy' });
+const finance = new Finance(); // You can use this: new Finance({ from 'USD', to: 'JPY' });
 // You can use http(s) proxies.
 /*
 const proxy = {
@@ -19,8 +21,8 @@ const finance = new Finance({ proxy });
 */
 
 finance
-  .setFrom('usd');
-  .setTo('jpy');
+  .setFrom('USD');
+  .setTo('JPY');
 
 (async () => {
   console.log(await finance.quote()); // { success: true, rate: 150.94225699999998 }

package/index.d.ts

@@ -15,8 +15,8 @@ declare module 'google-finance-quote' {
   /**
    * @interface FinanceParams
    * @description Interface for Finance class constructor parameters.
-   * @property {string} from - The original currency unit.
-   * @property {string} to - The desired currency unit.
+   * @property {string} from - The original currency symbol.
+   * @property {string} to - The desired currency symbol.
    * @property {Proxy | undefined} proxy - Proxy options.
    */
   interface FinanceParams {
@@ -37,7 +37,7 @@ declare module 'google-finance-quote' {
     /**
      * @function setFrom
      * @description Set the parameter of from.
-     * @param {string} from - The original currency unit.
+     * @param {string} from - The original currency symbol.
      * @returns {Finance} Returns the instance of Finance for chaining.
      */
     setFrom(from: string): Finance;
@@ -45,7 +45,7 @@ declare module 'google-finance-quote' {
     /**
      * @function setTo
      * @description Set the parameter of to.
-     * @param {string} to - The desired currency unit.
+     * @param {string} to - The desired currency symbol.
      * @returns {Finance} Returns the instance of Finance for chaining.
      */
     setTo(to: string): Finance;

package/index.js

@@ -1,25 +1,26 @@
 const axios = require('axios');
 const HttpsProxyAgent = require('https-proxy-agent');
 const { API_URL } = require('./lib/config');
+const symbols = require('./lib/symbols');
 
 /**
  * @class Finance
  * @description The Finance class is designed to easily check the exchange rate.
  * @param {Object} p - The param includes p.from and p.to.
- * @param {string} p.from - The original currency unit.
- * @param {string} p.to - The desired currency unit.
+ * @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) {
     if (
       typeof p === 'object' &&
-      typeof p?.from === 'string' &&
-      typeof p?.to === 'string'
+      symbols.includes(from?.toUpperCase()) &&
+      symbols.includes(to?.toUpperCase())
     ) {
       this.param = {
-        from: p.from,
-        to: p.to
+        from: p.from.toUpperCase(),
+        to: p.to.toUpperCase()
       };
     } else if (typeof p === 'undefined') {
       this.param = {
@@ -47,27 +48,27 @@ class Finance {
   /**
    * @function setFrom
    * @description Set the parameter of from.
-   * @param {string} from - The original currency unit.
+   * @param {string} from - The original currency symbol.
    * @returns {Finance} Returns the instance of Finance for chaining.
    */
   setFrom(from) {
-    if (typeof from !== 'string') throw new Error('from must be string.');
-    this.param.from = from;
+    if (!symbols.includes(from?.toUpperCase())) throw new Error('invalid from.');
+    this.param.from = from.toUpperCase();
     return this;
   }
 
   /**
    * @function setTo
    * @description Set the parameter of to.
-   * @param {string} to - The desired currency unit.
+   * @param {string} to - The desired currency symbol.
    * @returns {Finance} Returns the instance of Finance for chaining.
    */
   setTo(to) {
-    if (typeof to !== 'string') throw new Error('to must be string.');
-    this.param.to = to;
+    if (!symbols.includes(to?.toUpperCase())) throw new Error('invalid to.');
+    this.param.to = to.toUpperCase();
     return this;
   }
-  
+
   /**
    * @function getParam
    * @description Returns the current param.
@@ -88,8 +89,8 @@ class Finance {
     const result = { success: false, rate: 0 };
     try {
       if (typeof amount !== 'number') throw new Error('amount must be number.');
-      const from = this.param.from?.toUpperCase(), to = this.param.to.toUpperCase();
-      if (typeof from !== 'string' || typeof to !== 'string') throw new Error('from and/or to are invalid.');
+      const from = this.param.from, to = this.param.to;
+      if (!symbols?.includes(from) || !symbols?.includes(to)) throw new Error('from and/or to are invalid.');
 
       const url = `${API_URL}${from}-${to}`;
 
@@ -131,4 +132,5 @@ class Finance {
   }
 }
 
-module.exports = Finance;
+module.exports.Finance = Finance;
+module.exports.symbols = symbols;

package/lib/symbols.js

@@ -0,0 +1,209 @@
+const symbols = [
+  // Currency Codes
+  'AED',
+  'AFN',
+  'ALL',
+  'AMD',
+  'ANG',
+  'ARS',
+  'AUD',
+  'AWG',
+  'AZN',
+  'BAM',
+  'BDT',
+  'BGN',
+  'BHD',
+  'BND',
+  'BOB',
+  'BRL',
+  'BTN',
+  'BWP',
+  'BYN',
+  'BZD',
+  'CAD',
+  'CHF',
+  'CLP',
+  'CNY',
+  'COP',
+  'CRC',
+  'CSD',
+  'CZK',
+  'CVE',
+  'DEM',
+  'DKK',
+  'DOP',
+  'DZD',
+  'EEK',
+  'EGP',
+  'EUR',
+  'FJD',
+  'FRF',
+  'GBP',
+  'GEL',
+  'GHS',
+  'HKD',
+  'HNL',
+  'HRK',
+  'HUF',
+  'IDR',
+  'ILS',
+  'INR',
+  'IQD',
+  'ISK',
+  'JMD',
+  'JOD',
+  'JPY',
+  'KES',
+  'KGS',
+  'KRW',
+  'KWD',
+  'KYD',
+  'KZT',
+  'LAK',
+  'LBP',
+  'LKR',
+  'LTL',
+  'MAD',
+  'MDL',
+  'MKD',
+  'MMK',
+  'MOP',
+  'MTL',
+  'MUR',
+  'MVR',
+  'MXN',
+  'MYR',
+  'NAD',
+  'NGN',
+  'NIO',
+  'NOK',
+  'NPR',
+  'NZD',
+  'OMR',
+  'PAB',
+  'PEN',
+  'PHP',
+  'PKR',
+  'PLN',
+  'PYG',
+  'QAR',
+  'RON',
+  'ROL',
+  'RSD',
+  'RUB',
+  'SAR',
+  'SCR',
+  'SEK',
+  'SGD',
+  'SIT',
+  'SKK',
+  'SVC',
+  'THB',
+  'TND',
+  'TRL',
+  'TRY',
+  'TTD',
+  'TWD',
+  'TZS',
+  'UAH',
+  'UGX',
+  'USD',
+  'UYU',
+  'UZS',
+  'VEB',
+  'VEF',
+  'VES',
+  'VND',
+  'WST',
+  'XCD',
+  'XOF',
+  'XPF',
+  'YER',
+  'ZAR',
+  // Cryptocurrency Codes
+  'BTC',
+  'ETH',
+  'ADA',
+  'BNB',
+  'USDT',
+  'XRP',
+  'DOGE',
+  'LINK',
+  'LTC',
+  'BCH',
+  'XLM',
+  'TRX',
+  'ETC',
+  'XMR',
+  'EOS',
+  'NEO',
+  'WAVES',
+  'DASH',
+  'OMG',
+  'DCR',
+  'XEM',
+  'MANA',
+  'ICX',
+  'QTUM',
+  'ZIL',
+  'BAT',
+  'BTG',
+  'BNT',
+  'ZRX',
+  'SC',
+  'ONT',
+  'DGB',
+  'NANO',
+  'LSK',
+  'GNO',
+  'XVG',
+  'ARDR',
+  'SNT',
+  'MAID',
+  'REP',
+  'ARK',
+  'FUN',
+  'STEEM',
+  'SYS',
+  'BTS',
+  'KMD',
+  'MONA',
+  'GAS',
+  'RDD',
+  'BTM',
+  'WTC',
+  'AION',
+  'GRS',
+  'BCN',
+  'VERI',
+  'DGD',
+  'PIVX',
+  'NXS',
+  'PPT',
+  'QASH',
+  'NEBL',
+  'SALT',
+  'GAME',
+  'FCT',
+  'NXT',
+  'PAY',
+  'XDN',
+  'SUB',
+  'KNC',
+  'GNT',
+  'REQ',
+  'VGX',
+  'TNB',
+  'ZCL',
+  'HSR',
+  'ICN',
+  'POWR',
+  'ENG',
+  'SAN',
+  'ELF',
+  'STRAT',
+  'QSP',
+  'RDN'
+];
+
+module.exports = symbols;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "google-finance-quote",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Node Google Finance API wrapper for free. No API key is required!",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -30,5 +31,10 @@
   "dependencies": {
     "axios": "^1.7.7",
     "https-proxy-agent": "^7.0.5"
-  }
+  },
+  "directories": {
+    "lib": "lib",
+    "test": "tests"
+  },
+  "devDependencies": {}
 }