{"analyzedAt":"2022-07-14T17:55:27.516Z","collected":{"metadata":{"name":"@blossomfinance/iso-4217-currencies","scope":"blossomfinance","version":"0.2.5","description":"Simply a list of ISO-4217 currencies with name, code, symbol, & decimal rounding","keywords":["currency","country","iso-4217","iso-3166","iso-3166-1","alpha","2","metadata","lookup","fx"],"date":"2021-11-23T15:20:27.992Z","author":{"name":"Matthew J. Martin","email":"matthew@blossomfinance.com","username":"matmar10"},"publisher":{"username":"matmar10","email":"matthew@blossomfinance.com"},"maintainers":[{"username":"matmar10","email":"matthew@blossomfinance.com"}],"repository":{"type":"git","url":"git+https://github.com/blossomfinance/iso-4217-currencies.git"},"links":{"npm":"https://www.npmjs.com/package/%40blossomfinance%2Fiso-4217-currencies","homepage":"https://github.com/blossomfinance/iso-4217-currencies#readme","repository":"https://github.com/blossomfinance/iso-4217-currencies","bugs":"https://github.com/blossomfinance/iso-4217-currencies/issues"},"license":"MIT","devDependencies":{"faker":"^5.5.3","release-it":"^14.10.0","tap-prettify":"^0.0.2","tap-spec":"^2.2.2","tape":"^5.2.2"},"releases":[{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":1},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":8},{"from":"2020-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":8}],"hasTestScript":true,"readme":"# ISO-4217 Currencies\n\nSimply a list of ISO-4217 currencies with name, code, symbol, & decimal rounding. Also, support for figuring out the currency based on ISO-3166-1 Alpha-2 country code.\n\n\n## Basic Usage\n\n```JavaScript\n\n// include it\nconst lib = require('@blossomfinance/iso-4217-currencies');\n\n// get metadata for a specific currency code\nconst usd = lib.currency('USD');\n// {\n//   \"symbol\": \"$\",\n//   \"name\": \"US Dollar\",\n//   \"symbolNative\": \"$\",\n//   \"decimalDigits\": 2,\n//   \"rounding\": 0,\n//   \"code\": \"USD\",\n//   \"namePlural\": \"US dollars\"\n// }\n\n// get currency metadata by country code\nconst eur = lib.currency('FR');\n// {\n//   \"symbol\": \"€\",\n//   \"name\": \"Euro\",\n//   \"symbolNative\": \"€\",\n//   \"decimalDigits\": 2,\n//   \"rounding\": 0,\n//   \"code\": \"EUR\",\n//   \"namePlural\": \"euros\"\n// }\n\n// get currency code for a country code\nconst code = lib.codeForCountry('CM');\n// \"XAF\"\n```\n\n## Exported API\n\n```JavaScript\nconst lib = require('@blossomfinance/iso-4217-currencies');\n\nconst {\n  // array of currency codes\n  // ['AED', 'AFN', ...]\n  codes,\n\n  // array of currency metadata\n  // [\n  //   {\n  //     \"symbol\": \"AED\",\n  //     \"name\": \"United Arab Emirates Dirham\",\n  //     \"symbolNative\": \"د.إ.‏\",\n  //     \"decimalDigits\": 2,\n  //     \"rounding\": 0,\n  //     \"code\": \"AED\",\n  //     \"namePlural\": \"UAE dirhams\"\n  //   },\n  //   ...\n  // ]\n  currencies,\n\n  // hash map of currency metadata indexed by currency code\n  // {\n  //   \"AED\": {\n  //     \"symbol\": \"AED\",\n  //     \"name\": \"United Arab Emirates Dirham\",\n  //     \"symbolNative\": \"د.إ.‏\",\n  //     \"decimalDigits\": 2,\n  //     \"rounding\": 0,\n  //     \"code\": \"AED\",\n  //     \"namePlural\": \"UAE dirhams\"\n  //   },\n  //   ...\n  // }\n  map,\n\n  // domain-specific errors thrown if currency code was not found:\n  CurrencyNotFoundError,\n\n  // domain-specific errors thrown if no currency code found for country code:\n  CountryCurrencyNotFoundError,\n\n} = lib;\n```\n\n\n## Why?\n\nMost solutions available are super overkill, not distributed as packages (e.g. gist), and/or out of date.\n\n## Credits\n\nOriginal inspiration was from [Kent Safranski](https://github.com/Fluidbyte) in the form of [this helpful Gist](https://gist.github.com/Fluidbyte/2973986)"},"npm":{"downloads":[{"from":"2022-07-13T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":11},{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":66},{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":426},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":1401},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":2801},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":5307}],"starsCount":0},"github":{"starsCount":4,"forksCount":1,"subscribersCount":1,"issues":{"count":1,"openCount":1,"distribution":{"3600":0,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":1,"70858800":0,"212576400":0},"isDisabled":false},"contributors":[{"username":"matmar10","commitsCount":16}],"commits":[{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":16}]},"source":{"files":{"readmeSize":2230,"testsSize":6157}}},"evaluation":{"quality":{"carefulness":0.355,"tests":0.6,"health":1,"branding":0},"popularity":{"communityInterest":7,"downloadsCount":467,"downloadsAcceleration":0.17041476407914802,"dependentsCount":0},"maintenance":{"releasesFrequency":0.6090753424657535,"commitsFrequency":0.1841095890410959,"openIssues":0,"issuesDistribution":0}},"score":{"final":0.5200937258710117,"detail":{"quality":0.7097338990415116,"popularity":0.05110191675730395,"maintenance":0.8265368151242908}}}