yahoo-exchange - npm Package Compare versions

Comparing version 2.0.2 to 2.0.3

package.json

@@ -14,3 +14,3 @@ {
   "main": "index.js",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "license": "MIT",
@@ -17,0 +17,0 @@ "dependencies": {

README-JP.md

@@ -25,38 +25,2 @@ # yahoo-exchange 疎開
 Array\<number\>Kは次のような項目が含まれます。 [Now, Changes, Changes percent, Previous Close, Open, Bid, Ask, Day's Range Min, Day's Range Max, 52 Week Range Min, 52 Week Range Max]
-### 例示コード
-* ``` javascript
-  getExchangeDataArray('USDKRW', data => console.log(data)); // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ]
-  ```
-* ``` javascript
-  getExchangeDataArray('USDKRW', data => console.log(data), error => console.log('[Error]' + error));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] または [Error] error message
-  ```
-* ``` javascript
-  getExchangeDataArray('USDKRW', (data,pair) => console.log(data,pair), error => console.log('[Error]' + error));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDRKW または [Error] error message
-  ```
-* ``` javascript
-  getExchangeDataArray('USDKRW', (data,pair) => console.log(data,pair), (error,pair) => console.log(`[Error:${pair}]${error}`));
-   // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDKRW または [Error:USDKRW] error message
-  ```
-* ``` javascript
-  getExchangeDataArray(['USDKRW', 'JPYKRW'], data => console.log(data));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ]
-  // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ]
-  ```
-* ``` javascript
-  getExchangeDataArray(['USDKRW', 'JPYKRW'], data => console.log(data), error => console.log('[Error]' + error));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] または [Error] error message
-  // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ] または [Error] error message
-  ```
-* ``` javascript
-   getExchangeDataArray(['USDKRW', 'JPYKRW'], (data,pair) => console.log(data, pair)), error => console.log('[Error]' + error));
-   // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDKRW または [Error] error message
-   // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ] JPYKRW または [Error] error message
-  ```
-* ``` javascript
-   getExchangeDataArray(['USDKRW', 'JPYKRW'], (data,pair) => console.log(data, pair)), (error,pair) => console.log(`[Error:${pair}]${error}`));
-   // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDKRW または [Error:USDKRW] error message
-   // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ] JPYKRW または [Error:JPYKRW] error message
-  ```
 ### 警告
@@ -105,25 +69,10 @@ getExchangeDataArrayは全体データをコールバック関数で返却しません。
 フェアリストを生成してくれます。
-### 例示コード
-* ``` javascript
-    const currency = ['USD','JPY'];
-    const base = ['KRW'];
-    getPairArray(currency,base);
-    // ['USDKRW','JPYKRW'];
-   ```
 ## getUnit(currency:string):string
 通貨の記号($など)を返還してくれます。 二つ以上の通貨を付けた場合には3文字ずつ分離して配列に返還します。
-### Example
-* ``` javascript
-    const currency = 'USD';
-    const currency2 = 'USDKRW';
-    getUnit(currency);
-    getUnit(currency2);
-    // '$'
-    // [ '$', '₩' ]
-  ```
-
 ## test.js
 * ``` javascript
   const yahooExchange = require('yahoo-exchange');
-  yahooExchange.getExchangeDataArray('USDKRW', data => console.log(data));
+  yahooExchange.getFxYahooJapan(v => console.log(v));
+  yahooExchange.getExchangeDataLowTraffic(v => console.log(v));
+  yahooExchange.getExchangeDataLowTrafficP().then(v => console.log(v));
   yahooExchange.getExchangeDataArray(['USDKRW', 'JPYKRW'], data => console.log(data));
@@ -134,3 +83,5 @@ yahooExchange.getExchangeDataArray('USDKRW', (data, pair) => console.log(data, pair));
   yahooExchange.getExchangeDataArray(['USDKRW', 'JPYKRW'], (data, pair) => console.log(data, pair), (error, pair) => console.log(`[Error] ${pair}\n${error}`));
-
+  yahooExchange.getUnit('KRW');
+  yahooExchange.getUnit('USDKRWJPYEUR');
+  yahooExchange.getPairArray(['USD'], ['KRW', 'JPY']);
   ```
@@ -137,0 +88,0 @@ ### 翻訳の誤りはイッシューに登録してください。

README-KR.md

@@ -25,39 +25,2 @@ # yahoo-exchange
 Array\<number\>는 다음과 같은 항목이 포함됩니다. [Now, Changes, Changes percent, Previous Close, Open, Bid, Ask, Day's Range Min, Day's Range Max, 52 Week Range Min, 52 Week Range Max]
-
-### 예시 코드
-* ``` javascript
-  getExchangeDataArray('USDKRW', data => console.log(data)); // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ]
-  ```
-* ``` javascript
-  getExchangeDataArray('USDKRW', data => console.log(data), error => console.log('[Error]' + error));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] 또는 [Error] error message
-  ```
-* ``` javascript
-  getExchangeDataArray('USDKRW', (data,pair) => console.log(data,pair), error => console.log('[Error]' + error));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDRKW 또는 [Error] error message
-  ```
-* ``` javascript
-  getExchangeDataArray('USDKRW', (data,pair) => console.log(data,pair), (error,pair) => console.log(`[Error:${pair}]${error}`));
-   // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDKRW 또는 [Error:USDKRW] error message
-  ```
-* ``` javascript
-  getExchangeDataArray(['USDKRW', 'JPYKRW'], data => console.log(data));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ]
-  // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ]
-  ```
-* ``` javascript
-  getExchangeDataArray(['USDKRW', 'JPYKRW'], data => console.log(data), error => console.log('[Error]' + error));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] 또는 [Error] error message
-  // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ] 또는 [Error] error message
-  ```
-* ``` javascript
-   getExchangeDataArray(['USDKRW', 'JPYKRW'], (data,pair) => console.log(data, pair)), error => console.log('[Error]' + error));
-   // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDKRW 또는 [Error] error message
-   // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ] JPYKRW 또는 [Error] error message
-  ```
-* ``` javascript
-   getExchangeDataArray(['USDKRW', 'JPYKRW'], (data,pair) => console.log(data, pair)), (error,pair) => console.log(`[Error:${pair}]${error}`));
-   // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDKRW 또는 [Error:USDKRW] error message
-   // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ] JPYKRW 또는 [Error:JPYKRW] error message
-  ```
 ### 경고
@@ -104,25 +67,10 @@ getExchangeDataArray는 Callback에 전체 데이터를 넘겨주지 않습니다.
 페어 목록을 생성해 줍니다.
-### 예시 코드
-* ``` javascript
-   const currency = ['USD','JPY'];
-   const base = ['KRW'];
-   getPairArray(currency,base);
-   // ['USDKRW','JPYKRW'];
-  ```
-
 ## getUnit(currency:string):string
 통화의 기호($ 등)을 반환합니다. 두개이상의 통화를 넣을 경우 3글자씩 분리되어 배열로 반환합니다.
-### Example
- * ``` javascript
-     const currency = 'USD';
-     const currency2 = 'USDKRW';
-     getUnit(currency);
-     getUnit(currency2);
-     // '$'
-     // [ '$', '₩' ]
-
 ## test.js
 * ``` javascript
   const yahooExchange = require('yahoo-exchange');
-  yahooExchange.getExchangeDataArray('USDKRW', data => console.log(data));
+  yahooExchange.getFxYahooJapan(v => console.log(v));
+  yahooExchange.getExchangeDataLowTraffic(v => console.log(v));
+  yahooExchange.getExchangeDataLowTrafficP().then(v => console.log(v));
   yahooExchange.getExchangeDataArray(['USDKRW', 'JPYKRW'], data => console.log(data));
@@ -133,7 +81,8 @@ yahooExchange.getExchangeDataArray('USDKRW', (data, pair) => console.log(data, pair));
   yahooExchange.getExchangeDataArray(['USDKRW', 'JPYKRW'], (data, pair) => console.log(data, pair), (error, pair) => console.log(`[Error] ${pair}\n${error}`));
-
+  yahooExchange.getUnit('KRW');
+  yahooExchange.getUnit('USDKRWJPYEUR');
+  yahooExchange.getPairArray(['USD'], ['KRW', 'JPY']);
   ```
-
 ## 사용된 라이브러리에 대한 저작권 고지
 아래의 라이브러리의 일부 코드가 이 프로젝트에 포함되었습니다.
 * [currency-symbol-map](https://github.com/bengourley/currency-symbol-map)

README.md

@@ -21,38 +21,3 @@ # yahoo-exchange
 Array\<number\> : [Now, Changes, Changes percent, Previous Close, Open, Bid, Ask, Day's Range Min, Day's Range Max, 52 Week Range Min, 52 Week Range Max]
-### Example
-* ``` javascript
-  getExchangeDataArray('USDKRW', data => console.log(data)); // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ]
-  ```
-* ``` javascript
-  getExchangeDataArray('USDKRW', data => console.log(data), error => console.log('[Error]' + error));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] or [Error] error message
-  ```
-* ``` javascript
-  getExchangeDataArray('USDKRW', (data,pair) => console.log(data,pair), error => console.log('[Error]' + error));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDRKW or [Error] error message
-  ```
-* ``` javascript
-  getExchangeDataArray('USDKRW', (data,pair) => console.log(data,pair), (error,pair) => console.log(`[Error:${pair}]${error}`));
-   // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDKRW or [Error:USDKRW] error message
-  ```
-* ``` javascript
-  getExchangeDataArray(['USDKRW', 'JPYKRW'], data => console.log(data));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ]
-  // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ]
-  ```
-* ``` javascript
-  getExchangeDataArray(['USDKRW', 'JPYKRW'], data => console.log(data), error => console.log('[Error]' + error));
-  // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] or [Error] error message
-  // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ] or [Error] error message
-  ```
-* ``` javascript
-   getExchangeDataArray(['USDKRW', 'JPYKRW'], (data,pair) => console.log(data, pair)), error => console.log('[Error]' + error));
-   // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDKRW or [Error] error message
-   // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ] JPYKRW or [Error] error message
-  ```
-* ``` javascript
-   getExchangeDataArray(['USDKRW', 'JPYKRW'], (data,pair) => console.log(data, pair)), (error,pair) => console.log(`[Error:${pair}]${error}`));
-   // [ 1071.27,  0.88,  0.08,  -0.11,  1070.22,  1071.27,  1072.27,  1069.13,  1072.45,  1055.21,  1158.36 ] USDKRW or [Error:USDKRW] error message
-   // [ 10.08,  0.03,  0.34,  -0.11,  10.047,  undefined,  undefined,  10.08,  10.065,  10.0245,  10.0968 ] JPYKRW or [Error:JPYKRW] error message
-  ```
+
 ### Warning
@@ -95,28 +60,12 @@ getExchangeDataArray does not return Arrays to Callback.
 * USDHKD
-
 ##  getPairArray(currency: Array<string>, base: Array<string>): Array<string>
 It returns a pair array.
-### Example
-* ``` javascript
-   const currency = ['USD','JPY'];
-   const base = ['KRW'];
-   getPairArray(currency,base);
-   // ['USDKRW','JPYKRW'];
-  ```
 ## getUnit(currency:string):string or Array<string>
-It Returns a currency sign or a list of currency sign
-### Example
-* ``` javascript
-    const currency = 'USD';
-    const currency2 = 'USDKRW';
-    getUnit(currency);
-    getUnit(currency2);
-    // '$';
-    // [ '$', '₩' ]
-  ```
- 
+It Returns a currency sign or a list of currency sign.
 ## test.js
 * ``` javascript
   const yahooExchange = require('yahoo-exchange');
-  yahooExchange.getExchangeDataArray('USDKRW', data => console.log(data));
+  yahooExchange.getFxYahooJapan(v => console.log(v));
+  yahooExchange.getExchangeDataLowTraffic(v => console.log(v));
+  yahooExchange.getExchangeDataLowTrafficP().then(v => console.log(v));
   yahooExchange.getExchangeDataArray(['USDKRW', 'JPYKRW'], data => console.log(data));
@@ -127,3 +76,5 @@ yahooExchange.getExchangeDataArray('USDKRW', (data, pair) => console.log(data, pair));
   yahooExchange.getExchangeDataArray(['USDKRW', 'JPYKRW'], (data, pair) => console.log(data, pair), (error, pair) => console.log(`[Error] ${pair}\n${error}`));
-
+  yahooExchange.getUnit('KRW');
+  yahooExchange.getUnit('USDKRWJPYEUR');
+  yahooExchange.getPairArray(['USD'], ['KRW', 'JPY']);
   ```
@@ -130,0 +81,0 @@ ## A copyright notice on the library used

No alert changes

Worsened metrics

Total package byte prevSize

58124

decreased by-12.77%

Number of lines in readme file

81

decreased by-37.69%

No dependency changes