{"analyzedAt":"2022-12-23T04:21:54.416Z","collected":{"metadata":{"name":"@dnvgl/i18n","scope":"dnvgl","version":"1.12.0","description":"A set of functions to support multiple languages/cultures in a browser or Node.js","keywords":["internationalization","globalization","i18n","l10n","ISO","ISO 3166","ISO 3166-1","ISO 4217","format"],"date":"2022-12-22T10:17:28.454Z","publisher":{"username":"krykar","email":"krystian.karczewski@dnv.com"},"maintainers":[{"username":"michael.goeke","email":"michael.goeke@dnv.com"},{"username":"bruno.pbarbosa","email":"bruno.barbosa@dnv.com"},{"username":"oystein.bjorke","email":"oystein.bjorke@dnv.com"},{"username":"krykar","email":"krystian.karczewski@dnv.com"}],"repository":{"type":"git","url":"git+https://github.com/dnvgl/i18n.git"},"links":{"npm":"https://www.npmjs.com/package/%40dnvgl%2Fi18n","homepage":"https://github.com/dnvgl/i18n","repository":"https://github.com/dnvgl/i18n","bugs":"https://github.com/dnvgl/i18n/issues"},"license":"MIT","devDependencies":{"@types/jest":"^29.2.4","@types/node":"^18.11.17","jest":"^29.3.1","jest-environment-jsdom":"^29.3.1","rimraf":"^3.0.2","ts-jest":"^29.0.3","ts-node":"^10.8.0","typescript":"^4.9.4"},"releases":[{"from":"2022-11-23T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":2},{"from":"2022-09-24T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":6},{"from":"2022-06-26T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":6},{"from":"2021-12-23T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":11},{"from":"2020-12-23T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":19}],"hasTestScript":true,"hasSelectiveFiles":true,"readme":"# General information\n\n`@dnvgl/i18n` is a set of functions to support multiple languages/cultures in a browser or Node.js. There is no dependency on other libraries (exception: TypeScript when using definitions). It's built on the ECMAScript native solutions like for example `Intl` API.\n\nThe purpose of this library is to provide all needed functionalities to support multiple languages/cultures in the web application. All functions have been designed to be simple and easy to use, that is why some native API are wrapped. This library was in use two years (commercial use by DNV company) before its open-source release ([`2021-04-13`](CHANGELOG.md#v010)).\n\nThe biggest advantage about the library is that it supports any language, using the culture of the browser.\n\n## 1. Supported environments\n\n### Browsers:\n- Chrome (+ mobile): last 2 versions\n- Firefox (+ mobile): last 2 versions\n- Safari (+ mobile): v14* or newer\n- Edge: last 2 versions\n\nThere is a build-in function to check it: [`isBrowserCompatible()`](DOCUMENTATION.md#isBrowserCompatible).\n\n\\* - [`formatCountry()`](DOCUMENTATION.md#formatCountry) and [`formatCurrency()`](DOCUMENTATION.md#formatCurrency) require Safari 14.1 (desktop) or 14.5 (mobile)\n\n### Node.js:\n- v14 or newer\n\n## 2. Installation\n\nUsing npm:\n```bash\nnpm install @dnvgl/i18n\n```\n\nUsing yarn:\n```bash\nyarn add @dnvgl/i18n\n```\n\n## 3. Usage\n\nImport functions or types from `@dnvgl/i18n`, example:\n```typescript\nimport { sort, formatNumber } from '@dnvgl/i18n';\n\nconst sortedItems = sort([\"Z\", \"a\", \"A\", \"z\", \"ś\"], \"asc\", \"pl-PL\"); // returns [\"a\", \"A\", \"ś\", \"z\", \"Z\"]\nconst numberFormattedInSpecificCulture = formatNumber(12486.4529, { maxPrecision: 2 }, \"de-DE\"); // returns \"12.486,45\"\nconst numberFormattedInLocalCulture = formatNumber(12486.4529); // returns \"12 486,4529\" using local browser culture (in this case 'pl-PL'); any culture can be supported out of the box\n```\n\n#### Module system\nLibrary supports `esm` modules tree shaking by default.\n\n#### Testing in Jest\n[Jest](https://jestjs.io/) does not support `esm` modules, and `@dnvgl/i18n` uses them. In order to test your application with Jest you have to add the following to your `package.json`:\n```json\n\"jest\": {\n  \"transformIgnorePatterns\": [\n    \"/node_modules/(?!@dnvgl/i18n)\"\n  ]\n}\n```\n\nWhen there is another package that requires ES6 only then the pattern is:\\\n`\"/node_modules/(?!(PACKAGE_1|PACKAGE_2))\"`, e.g. `\"/node_modules/(?!(@dnvgl/i18n|another-package))\"`\n\n#### TypeScript\nLibrary provides a built-in ts definition.\n\n## 4. Contributing\nSee the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.\n\n## 5. Documentation\nSee full details in the [`DOCUMENTATION.md`](DOCUMENTATION.md) file.\n\n#### Number formatting/parsing/utils\n[`formatInteger()`](DOCUMENTATION.md#formatInteger), [`formatNumber()`](DOCUMENTATION.md#formatnumber), [`formatNumberToFixed()`](DOCUMENTATION.md#formatNumberToFixed), [`parseNumber()`](DOCUMENTATION.md#parseNumber), [`transformToInputNumericString()`](DOCUMENTATION.md#transformToInputNumericString), [`roundUsingHalfAwayFromZero()`](DOCUMENTATION.md#roundUsingHalfAwayFromZero), [`getDecimalSeparator()`](DOCUMENTATION.md#getDecimalSeparator), [`getMinusSign()`](DOCUMENTATION.md#getMinusSign), [`getThousandsSeparator()`](DOCUMENTATION.md#getThousandsSeparator), [`createNumberFormat()`](DOCUMENTATION.md#createNumberFormat)\n\n#### Datetime formatting\n[`formatDate()`](DOCUMENTATION.md#formatDate), [`formatDatePart()`](DOCUMENTATION.md#formatDatePart), [`formatDateToISO()`](DOCUMENTATION.md#formatDateToISO), [`formatRelativeTime()`](DOCUMENTATION.md#formatRelativeTime), [`formatMonth()`](DOCUMENTATION.md#formatMonth), [`formatTime()`](DOCUMENTATION.md#formatTime), [`getDateFnsFormat()`](DOCUMENTATION.md#getDateFnsFormat), [`getMomentFormat()`](DOCUMENTATION.md#getMomentFormat)\n\n#### Sorting/comparison\n[`compareBooleans()`](DOCUMENTATION.md#compareBooleans), [`compareDates()`](DOCUMENTATION.md#compareDates), [`compareNumbers()`](DOCUMENTATION.md#compareNumbers), [`compareNumbersAlike()`](DOCUMENTATION.md#compareNumbersAlike), [`compareStrings()`](DOCUMENTATION.md#compareStrings), [`compareStringsFactory()`](DOCUMENTATION.md#compareStringsFactory), [`sort()`](DOCUMENTATION.md#sort-sortinplace), [`sortBy()`](DOCUMENTATION.md#sortby-sortbyinplace), [`sortByInplace()`](DOCUMENTATION.md#sortby-sortbyinplace), [`sortInplace()`](DOCUMENTATION.md#sort-sortinplace)\n\n#### String formatting/utils\n[`capitalizeFirstLetter()`](DOCUMENTATION.md#capitalizeFirstLetter), [`formatString()`](DOCUMENTATION.md#formatString), [`lowercaseFirstLetter()`](DOCUMENTATION.md#lowercaseFirstLetter), [`normalizeForSearching()`](DOCUMENTATION.md#normalizeForSearching), [`plural()`](DOCUMENTATION.md#plural)\n\n#### Country utils\n[`findIso3166Country()`](DOCUMENTATION.md#findIso3166Country), [`formatCountry()`](DOCUMENTATION.md#formatCountry), [`getIso3166Countries()`](DOCUMENTATION.md#getIso3166Countries), [`getStatesOfUsa()`](DOCUMENTATION.md#getStatesOfUsa), [`isEuropeanUnionMember()`](DOCUMENTATION.md#isEuropeanUnionMember), [`isValidIso3166Code()`](DOCUMENTATION.md#isValidIso3166Code)\n\n#### Currency utils\n[`findIso4217Currency()`](DOCUMENTATION.md#findIso4217Currency), [`formatCurrency()`](DOCUMENTATION.md#formatCurrency), [`getIso4217Currencies()`](DOCUMENTATION.md#getIso4217Currencies), [`getCurrencySymbol()`](DOCUMENTATION.md#getCurrencySymbol), [`isValidIso4217Code()`](DOCUMENTATION.md#isValidIso4217Code)\n\n#### Financial utils\n[`formatMoney()`](DOCUMENTATION.md#formatMoney), [`formatIban()`](DOCUMENTATION.md#formatIban), [`getCountryCodeFromBic()`](DOCUMENTATION.md#getCountryCodeFromBic), [`getCountryCodeFromIban()`](DOCUMENTATION.md#getCountryCodeFromIban), [`roundUsingBankersMethod()`](DOCUMENTATION.md#roundUsingBankersMethod)\n\n#### Others\n[`getSystemLocaleName()`](DOCUMENTATION.md#getSystemLocaleName), [`isBrowserCompatible()`](DOCUMENTATION.md#isBrowserCompatible)\n\n## 6. Changelog\nSee the [`CHANGELOG.md`](CHANGELOG.md) file."},"npm":{"downloads":[{"from":"2022-12-22T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":0},{"from":"2022-12-16T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":101},{"from":"2022-11-23T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":411},{"from":"2022-09-24T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":1522},{"from":"2022-06-26T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":2863},{"from":"2021-12-23T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":4081}],"starsCount":0},"github":{"starsCount":5,"forksCount":1,"subscribersCount":4,"issues":{"count":1,"openCount":0,"distribution":{"3600":1,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":0,"70858800":0,"212576400":0},"isDisabled":false},"contributors":[{"username":"karczk-dnv","commitsCount":65},{"username":"damianfijorek","commitsCount":1}],"commits":[{"from":"2022-12-16T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":4},{"from":"2022-11-23T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":4},{"from":"2022-09-24T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":17},{"from":"2022-06-26T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":17},{"from":"2021-12-23T00:00:00.000Z","to":"2022-12-23T00:00:00.000Z","count":31}]},"source":{"files":{"readmeSize":5981,"testsSize":61340,"hasChangelog":true}}},"evaluation":{"quality":{"carefulness":0.8699999999999999,"tests":0.6,"health":1,"branding":0},"popularity":{"communityInterest":12,"downloadsCount":507.3333333333333,"downloadsAcceleration":1.8109779299847792,"dependentsCount":0},"maintenance":{"releasesFrequency":1,"commitsFrequency":0.9,"openIssues":1,"issuesDistribution":1}},"score":{"final":0.6181320307592959,"detail":{"quality":0.8301482902203752,"popularity":0.054547856419924025,"maintenance":0.9999879827034572}}}