Nerds Publishing Monstrosities

    country-to-iso
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.0 • Public • Published

    Country to ISO 3166-1 alpha-2/alpha-3

    Convert inconsistent country names and codes into ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3.

    The aim is support English only but some native languages are included.

    Usage

    import { countryToAlpha2, countryToAlpha3 } from "country-to-iso";
    // const { countryToAlpha2, countryToAlpha3 } = require("country-to-iso");
    
    // countryToAlpha2
    countryToAlpha2("US"); // returns "US"
    countryToAlpha2("USA"); // returns "US"
    countryToAlpha2("U S A"); // returns "US"
    countryToAlpha2("U.S.A"); // returns "US"
    countryToAlpha2("US of A"); // returns "US"
    countryToAlpha2("US and A"); // returns "US"
    countryToAlpha2("United States"); // returns "US"
    countryToAlpha2("United States of America"); // returns "US"
    countryToAlpha2("America"); // returns "US"
    
    // countryToAlpha3 
    countryToAlpha3("US"); // returns "USA"
    // etc...

    Commands

    Script Description
    npm run build Builds project to lib/.
    npm run seed Takes data from the libraries countryjs and country-list and updates data/iso-alpha-*.json and data/country/*.json files.
    npm run generate Takes seeded data, makes variants of names, checks for clashes (there's no mechanism to handle clashes as it's not come up) and dumps the data to data/names.json.
    npm test Runs tests.

    Adding New Country Name Variants

    Update Seed Libraries

    npm update --save-dev countryjs country-list
    npm run seed
    npm run generate
    npm test
    

    Manually Add Variants

    Manually it manually to the correct data/country/*.json file and run:

    npm run generate
    npm test
    

    Install

    npm i country-to-iso

    DownloadsWeekly Downloads

    1,559

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    171 kB

    Total Files

    290

    Last publish

    Collaborators

    • nojacko