{"analyzedAt":"2022-07-08T04:07:00.681Z","collected":{"metadata":{"name":"mobitel-iso-4217-currencies","scope":"unscoped","version":"1.1.1","description":"NodeJs module based on ISO-4217 for validate and get basic info by currency","keywords":["iso-4217","currency","code","validate","get","mobitel"],"date":"2017-10-16T22:31:50.087Z","author":{"name":"Dmitry Furman aka PragmaWolf, Mobitel Ltd","email":"pragmawolf@gmail.com","username":"mobitel-ltd"},"publisher":{"username":"mobitel-ltd","email":"pragmawolf@gmail.com"},"maintainers":[{"username":"mobitel-ltd","email":"pragmawolf@gmail.com"}],"repository":{"type":"git","url":"git+https://github.com/mobitel-ltd/mobitel-iso-4217-currencies.git"},"links":{"npm":"https://www.npmjs.com/package/mobitel-iso-4217-currencies","homepage":"https://github.com/mobitel-ltd/mobitel-iso-4217-currencies#readme","repository":"https://github.com/mobitel-ltd/mobitel-iso-4217-currencies","bugs":"https://github.com/mobitel-ltd/mobitel-iso-4217-currencies/issues"},"license":"MIT","devDependencies":{"eslint":"^4.8.0","eslint-config-google":"^0.9.1","mocha":"^4.0.1"},"releases":[{"from":"2022-06-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":0},{"from":"2022-04-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":1},{"from":"2022-01-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":1},{"from":"2021-07-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":1},{"from":"2020-07-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":1}],"hasTestScript":true,"readme":"# Mobitel Ltd. ISO-4217 Currencies\nNodeJs module based on ISO-4217 for validate and get basic info by currency\n\n## Attention\nThis module writing and testing on **NodeJs v.8+** and **NPM v.5+**.\nUsing the module in previous versions of NodeJs does not guarantee correct works.\n\n## <a name=\"navigation\">Navigation</a>\n\n* [Installation](#installation)\n* [Example](#example)\n* [API](#api)\n    * [.list](#list)\n    * [.validate()](#validate)\n    * [.get()](#get)\n    * [.getCodeList()](#get-code-list)\n* [Testing](#testing)\n* [License](#license)\n\n## <a name=\"installation\">Installation</a>\n\n```\nnpm i --save mobitel-iso-4217-currencies\n```\n[<p align=\"right\">up to navigation</p>](#navigation)\n\n## <a name=\"example\">Example</a>\n> Now for each currency exist:\n> * **country** - Country name\n> * **currency**- Currency name\n> * **alpha3** - Alphabetic code of currency\n> * **numeric** - Numeric code of currency\n> * **minor** - Number of decimals\n\n```javascript\nconst isoCurrencies = required('mobitel-iso-4217-currencies');\n\n// validate\nconst valid3 = isoCurrencies.validate('AFN'); //=> true\nconst validNum = isoCurrencies.validate('971'); //=> true\nconst invalid3 = isoCurrencies.validate('AF'); //=> false\nconst invalidNum = isoCurrencies.validate('000'); //=> false\n\n// get data\nconst data3 = isoCurrencies.get('AFG'); //=> {country: 'Afghanistan', currency: 'Afghani', alpha3: 'AFN', numeric: '971', minor: 2}\nconst dataNum = isoCurrencies.get('004'); //=> {country: 'Afghanistan', currency: 'Afghani', alpha3: 'AFN', numeric: '971', minor: 2}\nconst noData3 = isoCurrencies.get('AF'); //=> null\nconst noDataNum = isoCurrencies.get('000'); //=> null\n\n// get list of codes\nconst listOfCodes1 = isoCurrencies.getCodeList('alpha3'); //=> ['AFN', ...]\nconst listOfCodes2 = isoCurrencies.getCodeList('alpha3', 'numeric'); //=> ['AFN', ..., '971', ...]\nconst listOfCodes3 = isoCurrencies.getCodeList(['alpha3']); //=>  ['AFN', ...]\nconst listOfCodes4 = isoCurrencies.getCodeList(['alpha3', 'numeric']); //=> ['AFN', ..., '971', ...]\n\nconst listOfCodes5 = isoCurrencies.getCodeList('unknown'); //=> null\nconst listOfCodes7 = isoCurrencies.getCodeList(['unknown']); //=>  null\nconst listOfCodes6 = isoCurrencies.getCodeList('unknown', 'numeric'); //=> null\nconst listOfCodes8 = isoCurrencies.getCodeList(['unknown', 'numeric']); //=> null\n```\n[<p align=\"right\">up to navigation</p>](#navigation)\n\n## <a name=\"api\">API</a>\n\n### <a name=\"list\">.list</a>\nProperty - `{country: String, alpha2: String, alpha3: String, numeric: String}[]` - contains full currencies list.\n\nExample\n```javascript\nconst list = isoCurrencies.list; //=> objects list \n```\n[<p align=\"right\">up to navigation</p>](#navigation)\n\n### <a name=\"validate\">.validate(code)</a>\nArgument - `String` - currency code like `'AFN'`(alpha3) or `'971'`(numeric).\n\nIf code exist return `true`, otherwise `false`.\n\nExample\n```javascript\nconst valid3 = isoCurrencies.validate('AFN'); //=> true\nconst validNum = isoCurrencies.validate('971'); //=> true\nconst invalid3 = isoCurrencies.validate('AF'); //=> false\nconst invalidNum = isoCurrencies.validate('000'); //=> false\n```\n[<p align=\"right\">up to navigation</p>](#navigation)\n\n### <a name=\"get\">.get(code)</a>\nArgument - `String` - currency code like `'AFN'`(alpha3) or `'971'`(numeric).\n\nIf code exist return object with simple currency data like \n`{country: 'Afghanistan', currency: 'Afghani', alpha3: 'AFN', numeric: '971', minor: 2}`, otherwise `null`.\n\n> **minor** - number of decimals\n\nExample\n```javascript\nconst data3 = isoCurrencies.get('AFG'); //=> {country: 'Afghanistan', currency: 'Afghani', alpha3: 'AFN', numeric: '971', minor: 2}\nconst dataNum = isoCurrencies.get('004'); //=> {country: 'Afghanistan', currency: 'Afghani', alpha3: 'AFN', numeric: '971', minor: 2}\nconst noData3 = isoCurrencies.get('AF'); //=> null\nconst noDataNum = isoCurrencies.get('000'); //=> null\n```\n[<p align=\"right\">up to navigation</p>](#navigation)\n\n### <a name=\"get-code-list\">.getCodeList(codeName[, codeName]|[codeName[, codeName]])</a>\nArguments - `String|String[]` - country code name. Can accept variants:\n* `codeName1`\n* `codeName1, codeName2`\n* `[codeName1]`\n* `[codeName1, codeName2]`\n\nReturn array of all exist codes from arguments or `null`.\n\nExample\n```javascript\nconst listOfCodes1 = isoCurrencies.getCodeList('alpha3'); //=> ['AFN', ...]\nconst listOfCodes2 = isoCurrencies.getCodeList('alpha3', 'numeric'); //=> ['AFN', ..., '971', ...]\nconst listOfCodes3 = isoCurrencies.getCodeList(['alpha3']); //=>  ['AFN', ...]\nconst listOfCodes4 = isoCurrencies.getCodeList(['alpha3', 'numeric']); //=> ['AFN', ..., '971', ...]\n\nconst listOfCodes5 = isoCurrencies.getCodeList('unknown'); //=> null\nconst listOfCodes7 = isoCurrencies.getCodeList(['unknown']); //=>  null\nconst listOfCodes6 = isoCurrencies.getCodeList('unknown', 'numeric'); //=> null\nconst listOfCodes8 = isoCurrencies.getCodeList(['unknown', 'numeric']); //=> null\n```\n[<p align=\"right\">up to navigation</p>](#navigation)\n\n## <a name=\"testing\">Test</a>\n\n    npm run test\n[<p align=\"right\">up to navigation</p>](#navigation)\n\n## <a name=\"testing\">License</a>\nMIT License.\nCopyright (c) 2017 Mobitel Ltd\n[<p align=\"right\">up to navigation</p>](#navigation)"},"npm":{"downloads":[{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":0},{"from":"2022-07-01T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":161},{"from":"2022-06-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":1050},{"from":"2022-04-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":3300},{"from":"2022-01-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":6279},{"from":"2021-07-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":13242}],"starsCount":0},"github":{"starsCount":2,"forksCount":0,"subscribersCount":3,"issues":{"count":0,"openCount":0,"distribution":{"3600":0,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":0,"70858800":0,"212576400":0},"isDisabled":false},"contributors":[{"username":"PragmaWolf","commitsCount":15}],"commits":[{"from":"2022-07-01T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":0},{"from":"2022-06-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":0},{"from":"2022-04-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":0},{"from":"2022-01-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":0},{"from":"2021-07-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":0}]},"source":{"files":{"readmeSize":5214,"testsSize":13652},"linters":["editorconfig","eslint"]}},"evaluation":{"quality":{"carefulness":0.84,"tests":0.6,"health":1,"branding":0},"popularity":{"communityInterest":6,"downloadsCount":1100,"downloadsAcceleration":-0.6688926940639259,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9,"commitsFrequency":0.9,"openIssues":0.9,"issuesDistribution":0.9}},"score":{"final":0.6135212507306864,"detail":{"quality":0.8262967790528932,"popularity":0.04478264322752695,"maintenance":0.9998808339576686}}}