@brixtol/i18n

Static GeoIP utility for generating basic i18n information from a country code.

Usage no npm install needed!

<script type="module">
  import brixtolI18n from 'https://cdn.skypack.dev/@brixtol/i18n';
</script>

README

@brixtol/i18n

Static GeoIP utilities which accepts a 3166-1 alpha-2 country code and returns a JSON object with relevant Geographical information.

Why?

The vast majority of GeoIP services were doing too much or too little. We wanted a basic static powered GeoIP that would return exactly what we required in a fast and efficient manner. This project is composed from a series of small packages that map information from a series of datasets.

Install

pnpm

pnpm add @brixtol/i18n

npm

npm install @brixtol/i18n

Yarn

yarn add @brixtol/i18n

Usage

Pass in a currency code that is lowercase, uppercase or a mixture of both. There are 2 exports available, the i18n is a curried function which will allow for mutation of the response in the 2nd callback. If you do not need to mutate then your use the geo export which will return the default response.

Response

The i18n response will return the following response (locale) information:

interface IGeoIP {
  /**
   * The 2 Letter country code
   */
  countryCode: string;
  /**
   * The Country Name (in English)
   */
  countryName: string;
  /**
   * The 3 letter Currency Code
   */
  currencyCode: string;
  /**
   * The Currency Symbol
   */
  currencySymbol: string;
  /**
   * The Currency Placement
   */
  currencyPlacement: string;
}

Example

import { i18n, geo } from '@brixtol/i18n';

const default = geo('NL')
// => IGeoIP

const mutator = i18n('NL')(locale => ({ ...locale, hello: 'hoi!' }))
// => IGeoIP & { hello: 'hoi!' }

Packages

This module constructs the response by using the following smaller modules:

License

Licensed under MIT

We ♡ open source!