{"analyzedAt":"2022-07-14T16:30:58.260Z","collected":{"metadata":{"name":"@brixtol/currency-symbols","scope":"brixtol","version":"1.1.1","description":"Mappings from 3 letter currency codes to currency symbol","keywords":["currency","mappings","country","3166-1 alpha-2","ISO 4217"],"date":"2021-09-09T21:40:30.484Z","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-symbols.git"},"links":{"npm":"https://www.npmjs.com/package/%40brixtol%2Fcurrency-symbols","homepage":"https://github.com/brixtol/currency-symbols#readme","repository":"https://github.com/brixtol/currency-symbols","bugs":"https://github.com/brixtol/currency-symbols"},"license":"MIT","dependencies":{"@brixtol/currency-codes":"^1.2.1","@brixtol/tsutils":"^1.4.1"},"devDependencies":{"@brixtol/eslint-config":"^1.0.1","@brixtol/prettier-config":"^1.0.3","@brixtol/rollup-config":"^1.2.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":4},{"from":"2020-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":8}],"hasTestScript":true,"readme":"## @brixtol/currency-symbols\n\nCurrency ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)) 3 letter code mappings to Currency symbol. used by the [Brixtol Textiles](https://www.brixtoltextiles.com) internal API when dealing with currency conversion and presentation locales.\n\n### Size\n\n**Minified**: 1.52 KB <br>\n**Gzipped**: 976 B\n\n### Install\n\n[pnpm](https://pnpm.js.org/en/cli/install)\n\n```cli\npnpm i @brixtol/currency-symbols\n```\n\n[npm](https://www.npmjs.com/)\n\n```cli\nnpm install @brixtol/currency-symbols\n```\n\n[Yarn](https://yarnpkg.com/)\n\n```cli\nyarn add @brixtol/currency-symbols\n```\n\n### Usage\n\nYou can pass in a currency code that is lowercase, uppercase or a mixture of both.\n\n```javascript\nimport { getCurrencySymbol } from \"@brixtol/currency-symbols\";\n\n// Currency code SEK (Krona)\nconst sek = getCurrencySymbol(\"SEK\"); // Kr\n\n// Currency code EUR (Euros)\nconst eur = getCurrencySymbol(\"eur\"); // €\n\n// Currency code USD (Dollar)\nconst usd = getCurrencySymbol(\"uSd\"); // $\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 { CurrencySymbols, ICurrencySymbols } from \"@brixtol/currency-symbols\";\n\n// Mapping Object\n\nCurrencySymbols.SEK; // kr\nCurrencySymbols.EUR; // €\nCurrencySymbols.RUB; // ₽\nCurrencySymbols.USD; // $\n\n// Interface\n\nICurrencySymbols.SEK; // kr\nICurrencySymbols.EUR; // €\nICurrencySymbols.RUB; // ₽\nICurrencySymbols.USD; // $\n```\n\n> The interface is identical to the mapping.\n\n### Crypto Mappings\n\nThe module supports 4 crypto currency mappings. Only cryptos that have alt-codes are supported, please submit a PR if any are missing.\n\n- BTC (Bitcoin)\n- ETH (Ethereum)\n- LTL (Litecoin)\n- XBT (Bitcoin)\n\n### Related\n\nCountry code to currency code mappings:\n\n- [@brixtol/currency-codes](https://github.com/brixtol/currency-codes)\n\nCountry code to country name (English) mappings:\n\n- [@brixtol/country-names](https://github.com/brixtol/country-names)\n\nCurrency Symbol placements (use with [currency.js](https://github.com/scurker/))\n\n- [@brixtol/currency-placements](https://github.com/brixtol/currency-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":30},{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":205},{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":693},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":1596},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":2965},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":3555}],"starsCount":0},"github":{"starsCount":1,"forksCount":0,"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},"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":0}]},"source":{"files":{"readmeSize":2674,"testsSize":1167,"hasNpmIgnore":true,"hasChangelog":true},"linters":["eslint","prettier"]}},"evaluation":{"quality":{"carefulness":0.9999999999999999,"tests":0.6,"health":1,"branding":0},"popularity":{"communityInterest":3,"downloadsCount":532,"downloadsAcceleration":5.023192541856925,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9,"commitsFrequency":0.9,"openIssues":0.9,"issuesDistribution":0.9}},"score":{"final":0.6166245759691388,"detail":{"quality":0.8464094502755721,"popularity":0.03640985428938068,"maintenance":0.9998808339576686}}}