{"analyzedAt":"2022-07-14T16:29:44.894Z","collected":{"metadata":{"name":"@brixtol/currency-codes","scope":"brixtol","version":"1.2.0","description":"Mappings for 2 letter (Alpha 2) country codes to 3 letter currency code.","keywords":["currencies","currency","mappings","country","3166-1 alpha-2","ISO 4217"],"date":"2021-10-24T22:02:43.988Z","author":{"name":"Νίκος Σαβίδης","email":"n@brixtol.com","url":"https://brixtoltextiles.com"},"publisher":{"username":"sissel","email":"nicos.savidis@gmail.com"},"maintainers":[{"username":"sissel","email":"nicos.savidis@gmail.com"}],"repository":{"type":"git","url":"git+https://github.com/brixtol/currency-codes.git"},"links":{"npm":"https://www.npmjs.com/package/%40brixtol%2Fcurrency-codes","homepage":"https://github.com/brixtol/currency-codes#readme","repository":"https://github.com/brixtol/currency-codes","bugs":"https://github.com/brixtol/currency-codes"},"license":"MIT","dependencies":{"@brixtol/country-names":"^1.2.1","@brixtol/tsutils":"^1.4.1"},"devDependencies":{"@brixtol/eslint-config":"^1.0.1","@brixtol/prettier-config":"^1.2.0","@brixtol/rollup-config":"^1.4.0","@brixtol/tsconfig":"^1.0.0","esm":"^3.2.25","typescript":"^4.3.5"},"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":6},{"from":"2020-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":10}],"hasTestScript":true,"readme":"## @brixtol/currency-codes\n\nCountry codes ([3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)) to Currency ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)) code mappings used by the [Brixtol Textiles](https://www.brixtoltextiles.com) internal API when dealing with pricing and currency conversions. Supports all 249 countries to currency maps.\n\nMinified: 2.23 KB <br>\nGzipped: 1.08 KB\n\n### Install\n\n[pnpm](https://pnpm.js.org/en/cli/install)\n\n```cli\npnpm i @brixtol/currency-codes\n```\n\n> Because pnpm is dope and does dope shit.\n\n[npm](https://www.npmjs.com/)\n\n```cli\nnpm install @brixtol/currency-codes\n```\n\n[Yarn](https://yarnpkg.com/)\n\n```cli\nyarn add @brixtol/currency-codes\n```\n\n### Usage\n\nYou can pass in a country code that is lowercase, uppercase or a mixture of both.\n\n```javascript\nimport { getCurrency } from \"@brixtol/currency-codes\";\n\n// Country code SE (Sweden)\nconst sek = getCurrency(\"SE\"); // SEK\n\n// Country code NL (Netherlands)\nconst eur = getCurrency(\"nl\"); // EUR\n\n// Country code US (United States)\nconst eur = getCurrency(\"uS\"); // USD\n\n// ....\n```\n\nThe module also exposes the raw mappings and interface on the export. The mappings object is provided **read only** using [Object.freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze). The raw mappings are annotated with JSDoc comments so when using an editor that supports intellisense (ie: vscode) you will receive the country and currency name in completions and hovers.\n\n```javascript\nimport { Currencies, ICurrencies } from \"@brixtol/currency-codes\";\n\n// Mapping Object\n\nCurrencies.SE; // SEK\nCurrencies.NL; // EUR\nCurrencies.RU; // RUB\n\n// Interface\n\nICurrencies.SE; // SEK\nICurrencies.NL; // EUR\nICurrencies.RU; // RUB\n```\n\n> The interface is identical to the mapping.\n\n### Related\n\nCurrency code to currency symbol mappings:\n\n- [@brixtol/currency-symbols](https://github.com/brixtol/currency-symbols)\n\nCountry code to country name mappings:\n\n- [@brixtol/country-names](https://github.com/brixtol/country-names)\n\nCurrency code to [currency.js](https://github.com/scurker/currency.js) symbol placement mappings:\n\n- [@brixtol/currency-symbol-placements](https://github.com/brixtol/currency-symbol-placements)\n\n### License\n\nLicensed under [MIT](#LICENCE)\n\n---\n\nWe [♡](https://www.brixtoltextiles.com/discount/4D3V3L0P3RS]) open source!"},"npm":{"downloads":[{"from":"2022-07-13T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":17},{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":126},{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":346},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":1233},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":2676},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":3185}],"starsCount":0},"github":{"starsCount":2,"forksCount":1,"subscribersCount":2,"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":"panoply","commitsCount":50}],"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":35}]},"source":{"files":{"readmeSize":2590,"testsSize":1176,"hasNpmIgnore":true,"hasChangelog":true},"linters":["eslint","prettier"]}},"evaluation":{"quality":{"carefulness":0.9999999999999999,"tests":0.6,"health":1,"branding":0},"popularity":{"communityInterest":6,"downloadsCount":411,"downloadsAcceleration":2.2369863013698628,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9,"commitsFrequency":0.9,"openIssues":0.9,"issuesDistribution":0.9}},"score":{"final":0.6213360393391479,"detail":{"quality":0.8464094502755721,"popularity":0.04986492311163655,"maintenance":0.9998870890497245}}}