{"_id":"@apollo-tech/country-codes","_rev":"10-1602605a9f36f7a391f994a702103722","name":"@apollo-tech/country-codes","dist-tags":{"latest":"1.0.4"},"versions":{"0.0.3":{"name":"@apollo-tech/country-codes","version":"0.0.3","keywords":["country","codes","country-codes","FIPS","ISO","ISO-3166-alpha-2","ISO-3166-alpha-3","ISO-3166-numeric","utility","typescript"],"author":{"name":"Steven Hall"},"license":"MIT","_id":"@apollo-tech/country-codes@0.0.3","maintainers":[{"name":"steven-t-h","email":"shall1313@gmail.com"}],"homepage":"https://github.com/steven-t-h/country-codes#readme","bugs":{"url":"https://github.com/steven-t-h/country-codes/issues"},"dist":{"shasum":"eff9129797419ec0133b3c6a27a5bf8797046407","tarball":"https://registry.npmjs.org/@apollo-tech/country-codes/-/country-codes-0.0.3.tgz","fileCount":9,"integrity":"sha512-LJ+Qbtg2w03qB2LmZmJv/bqDv90+Bb67r8j1wDE9CxTyNuenHZyNKS3HFMyllETz+S1f/uZJnbygfgqNpqz3OQ==","signatures":[{"sig":"MEYCIQD/Sb++ryWbbGmp9A3sPOeXEn1O616SGzNj3lUsTuQZ8wIhAJpDnOEiXuFaCyKVYL/vPNFf9potAVaYFHJt7Hwf5mU0","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":379057},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","private":false,"scripts":{"test":"jest","build":"tsup","deploy":"npm run build && npm publish --access public","test:cov":"jest --coverage","prepublish":"npm run build","preversion":"npm test"},"_npmUser":{"name":"steven-t-h","email":"shall1313@gmail.com"},"repository":{"url":"git+https://github.com/steven-t-h/country-codes.git","type":"git"},"_npmVersion":"10.2.4","description":"A simple utility for retrieving country codes and names","directories":{},"_nodeVersion":"18.19.1","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","tsup":"^8.3.0","ts-jest":"^29.2.5","typescript":"^5.6.2","@types/jest":"^29.5.13","@types/node":"^22.7.4"},"_npmOperationalInternal":{"tmp":"tmp/country-codes_0.0.3_1728613267480_0.48625666924648625","host":"s3://npm-registry-packages"}},"0.0.4":{"name":"@apollo-tech/country-codes","version":"0.0.4","keywords":["country","codes","country-codes","FIPS","ISO","ISO-3166-alpha-2","ISO-3166-alpha-3","ISO-3166-numeric-3","alpha-2","alpha-3","numeric-3","utility","typescript"],"author":{"name":"Steven Hall"},"license":"MIT","_id":"@apollo-tech/country-codes@0.0.4","maintainers":[{"name":"steven-t-h","email":"shall1313@gmail.com"}],"homepage":"https://github.com/steven-t-h/country-codes#readme","bugs":{"url":"https://github.com/steven-t-h/country-codes/issues"},"dist":{"shasum":"9c5e3f466738ae14c1b2c69269fea8ca674dad12","tarball":"https://registry.npmjs.org/@apollo-tech/country-codes/-/country-codes-0.0.4.tgz","fileCount":9,"integrity":"sha512-3bYXS9lMCJ5/L2TCSf78mgP0J7RCaQeyz/zlZdHm7Z0OeWUzK7X4PubXpBQVTTDd304qji9jzbgZhDTXTWwU3w==","signatures":[{"sig":"MEYCIQD05p8X7XkD3GWQ+4ZbpRaerAHsSO3gawQUU0F5SirlgQIhALYHdO2/mcqb6a/7HWfm2tXdakfrahFGQd85S3RHOJ3c","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":380824},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","private":false,"scripts":{"test":"jest","build":"tsup","deploy":"npm run build && npm publish --access public","test:cov":"jest --coverage","prepublish":"npm run build","preversion":"npm test"},"_npmUser":{"name":"steven-t-h","email":"shall1313@gmail.com"},"repository":{"url":"git+https://github.com/steven-t-h/country-codes.git","type":"git"},"_npmVersion":"10.2.4","description":"A simple utility for retrieving country codes and names","directories":{},"_nodeVersion":"18.19.1","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","tsup":"^8.3.0","ts-jest":"^29.2.5","typescript":"^5.6.2","@types/jest":"^29.5.13","@types/node":"^22.7.4"},"_npmOperationalInternal":{"tmp":"tmp/country-codes_0.0.4_1728614209711_0.4487311719372813","host":"s3://npm-registry-packages"}},"1.0.0":{"name":"@apollo-tech/country-codes","version":"1.0.0","keywords":["country","codes","country-codes","FIPS","ISO","ISO-3166-alpha-2","ISO-3166-alpha-3","ISO-3166-numeric-3","alpha-2","alpha-3","numeric-3","utility","typescript"],"author":{"name":"Steven Hall"},"license":"MIT","_id":"@apollo-tech/country-codes@1.0.0","maintainers":[{"name":"steven-t-h","email":"shall1313@gmail.com"}],"homepage":"https://github.com/steven-t-h/country-codes#readme","bugs":{"url":"https://github.com/steven-t-h/country-codes/issues"},"dist":{"shasum":"7e5dad53ea6d731bdd29dd4282143c5147ce9cc1","tarball":"https://registry.npmjs.org/@apollo-tech/country-codes/-/country-codes-1.0.0.tgz","fileCount":9,"integrity":"sha512-0gwWUZxYq/1EPDuVBLe4k7l6WZSxcdXiDlsIVclj4hZAmU/BtWv+vSzFbeXpGTuzP6OZbVpV8soso0v7T/Uv2w==","signatures":[{"sig":"MEUCIQCGyq31P8ndO3nt6PLDGwzQRAZWaskKhyHWfLecrEjpHwIgNPldGn4n0O4nnZtoyzNgf1JhvHgC0LhAvJbbzuxvMpE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":383899},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","private":false,"scripts":{"test":"jest","build":"tsup","deploy":"npm run build && npm publish --access public","test:cov":"jest --coverage","prepublish":"npm run build","preversion":"npm test"},"_npmUser":{"name":"steven-t-h","email":"shall1313@gmail.com"},"repository":{"url":"git+https://github.com/steven-t-h/country-codes.git","type":"git"},"_npmVersion":"10.2.4","description":"A simple utility for retrieving country codes and names","directories":{},"_nodeVersion":"18.19.1","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","tsup":"^8.3.0","ts-jest":"^29.2.5","ts-node":"^10.9.2","typescript":"^5.6.2","@types/jest":"^29.5.13","@types/node":"^22.7.4"},"_npmOperationalInternal":{"tmp":"tmp/country-codes_1.0.0_1728626026007_0.2934909493566207","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@apollo-tech/country-codes","version":"1.0.1","keywords":["country","codes","country-codes","FIPS","ISO","ISO-3166-alpha-2","ISO-3166-alpha-3","ISO-3166-numeric-3","alpha-2","alpha-3","numeric-3","utility","typescript"],"author":{"name":"Steven Hall"},"license":"MIT","_id":"@apollo-tech/country-codes@1.0.1","maintainers":[{"name":"steven-t-h","email":"shall1313@gmail.com"}],"homepage":"https://github.com/steven-t-h/country-codes#readme","bugs":{"url":"https://github.com/steven-t-h/country-codes/issues"},"dist":{"shasum":"5750500c4ead133437e4677f8aec5d7abb7336f7","tarball":"https://registry.npmjs.org/@apollo-tech/country-codes/-/country-codes-1.0.1.tgz","fileCount":9,"integrity":"sha512-Wkd3M8MH/HYKN3eiBht/PfHMLtQ1f+P0Nohft5H66QUMv/XkT0I5MUqk3mhcb6VOfa22xySpsTL3qDMc1fvRCw==","signatures":[{"sig":"MEYCIQDM3IcIYUdTN8GgzfGUoD7Db6I9V6Jq/QgtPd9zu+gOqgIhAL5E4licgmP+hI2NfV3cQC6/NIQG+lFj96h2oxrfjoMf","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":386011},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","gitHead":"7fc284109a9e7520e48518f8842c8a25611e7e81","private":false,"scripts":{"lint":"eslint src/**/*.ts","test":"jest","build":"tsup","deploy":"npm test && npm run build && npm publish --access public","format":"prettier --write \"src/**/*.ts\"","prepare":"husky && husky install","prepush":"npm run lint","lint:fix":"eslint --fix src/**/*.ts","test:cov":"jest --coverage","predeploy":"npm run lint && npm test"},"_npmUser":{"name":"steven-t-h","email":"shall1313@gmail.com"},"repository":{"url":"git+https://github.com/steven-t-h/country-codes.git","type":"git"},"_npmVersion":"10.2.4","description":"A simple utility for retrieving country codes and names","directories":{},"lint-staged":{"*.js":"eslint --cache --fix","*.ts":"prettier --write"},"_nodeVersion":"18.19.1","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","tsup":"^8.3.0","husky":"^9.1.6","eslint":"^9.12.0","globals":"^15.11.0","ts-jest":"^29.2.5","ts-node":"^10.9.2","prettier":"3.3.3","@eslint/js":"^9.12.0","typescript":"^5.6.3","@types/jest":"^29.5.13","@types/node":"^22.7.5","lint-staged":"^15.2.10","@commitlint/cli":"^19.5.0","typescript-eslint":"^8.8.1","eslint-plugin-jest":"^28.8.3","eslint-config-prettier":"^9.1.0","@commitlint/config-conventional":"^19.5.0"},"_npmOperationalInternal":{"tmp":"tmp/country-codes_1.0.1_1728632423790_0.7700864946820769","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@apollo-tech/country-codes","version":"1.0.2","keywords":["country","codes","country-codes","FIPS","ISO","ISO-3166-alpha-2","ISO-3166-alpha-3","ISO-3166-numeric-3","alpha-2","alpha-3","numeric-3","utility","typescript"],"author":{"name":"Steven Hall"},"license":"MIT","_id":"@apollo-tech/country-codes@1.0.2","maintainers":[{"name":"steven-t-h","email":"shall1313@gmail.com"}],"homepage":"https://github.com/apollo-tech-dev/country-codes#readme","bugs":{"url":"https://github.com/apollo-tech-dev/country-codes/issues"},"dist":{"shasum":"c8e99c0764858d61053981ef38120840906211a1","tarball":"https://registry.npmjs.org/@apollo-tech/country-codes/-/country-codes-1.0.2.tgz","fileCount":9,"integrity":"sha512-AUjFDBEr4yJf6drp9lI2f4FDDjhiOTgHecszsgn1QcjqBdggHxCIJuXjjvqPY9ejTCFDuhUWSpaglf4B5/korQ==","signatures":[{"sig":"MEYCIQCWfTXx3K8t2kuNoxGdLp2lU4rrxMnC8apMp22N/RhMpQIhANC0tIrZIuXMrJxj3dXbT2ktNNWdLN7Czw2XHlEyoqXP","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":386334},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","gitHead":"005f87153485330a0241b5274fe88b71bbbb1637","private":false,"scripts":{"lint":"eslint src/**/*.ts","test":"jest","build":"tsup","deploy":"npm test && npm run build && npm publish --access public","format":"prettier --write \"src/**/*.ts\"","prepare":"husky && husky install","prepush":"npm run lint","lint:fix":"eslint --fix src/**/*.ts","test:cov":"jest --coverage","predeploy":"npm run lint && npm test"},"_npmUser":{"name":"steven-t-h","email":"shall1313@gmail.com"},"repository":{"url":"git+https://github.com/apollo-tech-dev/country-codes.git","type":"git"},"_npmVersion":"10.2.4","description":"A simple utility for retrieving country codes and names","directories":{},"lint-staged":{"*.js":"eslint --cache --fix","*.ts":"prettier --write"},"_nodeVersion":"18.19.1","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","tsup":"^8.3.0","husky":"^9.1.6","eslint":"^9.12.0","globals":"^15.11.0","ts-jest":"^29.2.5","ts-node":"^10.9.2","prettier":"3.3.3","@eslint/js":"^9.12.0","typescript":"^5.6.3","@types/jest":"^29.5.13","@types/node":"^22.7.5","lint-staged":"^15.2.10","@commitlint/cli":"^19.5.0","typescript-eslint":"^8.8.1","eslint-plugin-jest":"^28.8.3","eslint-config-prettier":"^9.1.0","@commitlint/config-conventional":"^19.5.0"},"_npmOperationalInternal":{"tmp":"tmp/country-codes_1.0.2_1728674479779_0.6185676310966555","host":"s3://npm-registry-packages"}},"1.0.3":{"name":"@apollo-tech/country-codes","version":"1.0.3","keywords":["country","codes","country-codes","FIPS","ISO","ISO-3166-alpha-2","ISO-3166-alpha-3","ISO-3166-numeric-3","alpha-2","alpha-3","numeric-3","utility","typescript"],"author":{"name":"Steven Hall"},"license":"MIT","_id":"@apollo-tech/country-codes@1.0.3","maintainers":[{"name":"steven-t-h","email":"shall1313@gmail.com"}],"homepage":"https://github.com/apollo-tech-dev/country-codes#readme","bugs":{"url":"https://github.com/apollo-tech-dev/country-codes/issues"},"dist":{"shasum":"ffae70f8fd071129bface639893cdfeafc17437b","tarball":"https://registry.npmjs.org/@apollo-tech/country-codes/-/country-codes-1.0.3.tgz","fileCount":9,"integrity":"sha512-lj8FdkjywyaIqnKdsnqRXuPTYneMBcQCcbViyun7ebkAT0m2cX+4nSdK+zMCNfNW1i+IvGiBluOJJOlny5Bw8Q==","signatures":[{"sig":"MEYCIQCWNlbLapRtqttxDRNQgCn46eB4i5YM+/VdEbIFQBmLWgIhAP/SXuxaTLRsrXhTfQcu5R1H20kE1hQIqXHRqAenEwB9","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":387318},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","gitHead":"c93f48297b1aaf149674a57e6c78a7fee3c9ae41","private":false,"scripts":{"lint":"eslint src/**/*.ts","test":"jest","build":"tsup","deploy":"npm test && npm run build && npm publish --access public","format":"prettier --write \"src/**/*.ts\"","prepare":"husky && husky install","prepush":"npm run lint","lint:fix":"eslint --fix src/**/*.ts","test:cov":"jest --coverage","predeploy":"npm run lint && npm test"},"_npmUser":{"name":"steven-t-h","email":"shall1313@gmail.com"},"repository":{"url":"git+https://github.com/apollo-tech-dev/country-codes.git","type":"git"},"_npmVersion":"10.8.2","description":"A simple utility for retrieving country codes and names","directories":{},"lint-staged":{"*.js":"eslint --cache --fix","*.ts":"prettier --write"},"_nodeVersion":"20.18.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","tsup":"^8.3.0","husky":"^9.1.6","eslint":"^9.12.0","globals":"^15.11.0","ts-jest":"^29.2.5","ts-node":"^10.9.2","prettier":"3.3.3","@eslint/js":"^9.12.0","typescript":"^5.6.3","@types/jest":"^29.5.13","@types/node":"^22.7.5","lint-staged":"^15.2.10","@commitlint/cli":"^19.5.0","typescript-eslint":"^8.8.1","eslint-plugin-jest":"^28.8.3","eslint-config-prettier":"^9.1.0","@commitlint/config-conventional":"^19.5.0"},"_npmOperationalInternal":{"tmp":"tmp/country-codes_1.0.3_1732755969345_0.5130083892927848","host":"s3://npm-registry-packages"}},"1.0.4":{"name":"@apollo-tech/country-codes","repository":{"type":"git","url":"git+https://github.com/apollo-tech-dev/country-codes.git"},"version":"1.0.4","private":false,"description":"A simple utility for retrieving country codes and names","main":"./dist/index.js","module":"./dist/index.mjs","types":"./dist/index.d.ts","scripts":{"test":"jest","test:cov":"jest --coverage","lint":"eslint src/**/*.ts","lint:fix":"eslint --fix src/**/*.ts","format":"prettier --write \"src/**/*.ts\"","build":"tsup","prepare":"husky && husky install","prepush":"npm run lint","predeploy":"npm run lint && npm test","deploy":"npm test && npm run build && npm publish --access public"},"keywords":["country","codes","country-codes","FIPS","ISO","ISO-3166-alpha-2","ISO-3166-alpha-3","ISO-3166-numeric-3","alpha-2","alpha-3","numeric-3","utility","typescript"],"author":{"name":"Steven Hall"},"license":"MIT","devDependencies":{"@commitlint/cli":"^19.6.1","@commitlint/config-conventional":"^19.6.0","@eslint/js":"^9.17.0","@types/jest":"^29.5.14","@types/node":"^22.10.5","eslint":"^9.17.0","eslint-config-prettier":"^9.1.0","eslint-plugin-jest":"^28.10.0","globals":"^15.14.0","husky":"^9.1.7","jest":"^29.7.0","lint-staged":"^15.3.0","prettier":"^3.4.2","ts-jest":"^29.2.5","ts-node":"^10.9.2","tsup":"^8.3.5","typescript":"^5.7.2","typescript-eslint":"^8.19.0"},"lint-staged":{"*.js":"eslint --cache --fix","*.ts":"prettier --write"},"_id":"@apollo-tech/country-codes@1.0.4","gitHead":"8b195e1c0d7bd21ce047fb5c5c47333c833dfe9f","bugs":{"url":"https://github.com/apollo-tech-dev/country-codes/issues"},"homepage":"https://github.com/apollo-tech-dev/country-codes#readme","_nodeVersion":"22.12.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-X8TRmEbORLOdANrNUyjJ18V4zZ4mqtR3E5Noydhb0hfWmSqFA70KNuAxzIcg0XYzrHxPT+2/HIkJJrPeKJsrfQ==","shasum":"cc7df775e7f7b0fe15428134ccf1dffe5617819f","tarball":"https://registry.npmjs.org/@apollo-tech/country-codes/-/country-codes-1.0.4.tgz","fileCount":9,"unpackedSize":387409,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEH+pBNACjebgA5OqeZFwKATP7+Q48alP6npKqaxR4wLAiBNIkulsAWLmZS/juWs83xXmurMmwD1kEnaW9qSXGs+wQ=="}]},"_npmUser":{"name":"steven-t-h","email":"shall1313@gmail.com"},"directories":{},"maintainers":[{"name":"steven-t-h","email":"shall1313@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/country-codes_1.0.4_1736138295698_0.9059678778279514"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-11T02:15:24.172Z","modified":"2025-01-06T04:38:16.061Z","0.0.1":"2024-10-11T02:15:24.459Z","0.0.2":"2024-10-11T02:16:16.956Z","0.0.3":"2024-10-11T02:21:07.737Z","0.0.4":"2024-10-11T02:36:49.934Z","1.0.0":"2024-10-11T05:53:46.204Z","1.0.1":"2024-10-11T07:40:24.022Z","1.0.2":"2024-10-11T19:21:20.036Z","1.0.3":"2024-11-28T01:06:09.548Z","1.0.4":"2025-01-06T04:38:15.874Z"},"bugs":{"url":"https://github.com/apollo-tech-dev/country-codes/issues"},"author":{"name":"Steven Hall"},"license":"MIT","homepage":"https://github.com/apollo-tech-dev/country-codes#readme","keywords":["country","codes","country-codes","FIPS","ISO","ISO-3166-alpha-2","ISO-3166-alpha-3","ISO-3166-numeric-3","alpha-2","alpha-3","numeric-3","utility","typescript"],"repository":{"type":"git","url":"git+https://github.com/apollo-tech-dev/country-codes.git"},"description":"A simple utility for retrieving country codes and names","maintainers":[{"name":"steven-t-h","email":"shall1313@gmail.com"}],"readme":"![NPM Version](https://img.shields.io/npm/v/%40apollo-tech%2Fcountry-codes)\n![GitHub License](https://img.shields.io/github/license/apollo-tech-dev/country-codes)\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/apollo-tech-dev/country-codes/ci.yml)\n\n# Country Codes\n\nA simple NPM package to search for country information based on various codes and names. This package provides methods\nto\nsearch for countries by FIPS code, ISO code, internet code, and country name.\n\nBuilt on Typescript for the best developer experience.\n\n___\n\n## Acknowledgements\n\nCredit to [richorama/country-code-lookup](https://github.com/richorama/country-code-lookup) for the base country data\nand the original scaffold for this package. The original package was converted to Typescript and was restructured with\na class-based approach to provide an alternative to the original package. Note that this original package contains\ntypes, so please choose the package that best suits your needs/development style.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Methods](#methods)\n    - [FIPS Codes](#fips-codes)\n    - [ISO Codes](#iso-codes)\n    - [Internet Codes](#internet-codes)\n    - [Country Name](#country-name)\n- [Response (Country)](#response-country)\n- [Which code should I use?](#which-code-should-i-use)\n- [Roadmap](#roadmap)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nInstall the package using npm:\n\n```bash\nnpm install @apollo-tech/country-codes\n```\n\n## Usage\n\nImport the package and use the provided methods to search for country information.\n\n```typescript\nimport CountryCodes from '@apollo-tech/country-codes';\n\nconst countryCodes = new CountryCodes();\n\n// Search for a country by FIPS code\nconst countryByFips = countryCodes.byFips('US');\nconsole.log(countryByFips);\n\n// Search for a country by ISO code\nconst countryByIso = countryCodes.byIso('USA');\nconsole.log(countryByIso);\n\n// Search for a country by internet code\nconst countryByInternet = countryCodes.byInternet('US');\nconsole.log(countryByInternet);\n\n// Search for a country by name\nconst countryByName = countryCodes.byCountry('United States');\nconsole.log(countryByName);\n```\n\n## Methods\n\n### FIPS Codes\n\nSearch for a country by FIPS code.\n\n`byFips(code: string): CountryResponse`\n\n### ISO Codes\n\nSearch for a country by ISO code. This method supports ISO2, ISO3, and ISO numeric codes. If you provide an invalid\nISO code type, the method will throw an error. You can enable `safeMode` to prevent the method from throwing an error\nand return `null` instead.\n\n`byIso(code: string | number, safeMode: boolean = false): CountryResponse`\n\n### Internet Codes\n\nSearch for a country by internet code.\n\n`byInternet(code: string): CountryResponse`\n\n### Country Name\n\nSearch for a country by name. This method is case-sensitive by default. Enable `ignoreCase` to perform a\ncase-insensitive search.\n\n`byCountry(country: string, ignoreCase: boolean = false): CountryResponse`\n\n## Response (Country)\n\nAll methods return a `CountryResponse` object which is either a `Country` object or `null`.\n\nFor simplicity of use, below is the structure of the `Country` object:\n\n```typescript\ninterface Country {\n    continent: string;\n    region: string;\n    country: string;\n    capital: string;\n    fips: string;\n    iso2: string;\n    iso3: string;\n    isoNo: number;\n    internet: string;\n}\n```\n\nThe `Country` object contains the following properties:\n\n- `continent` - The name of the country's continent.\n- `region` - The region of the country.\n- `country` - The name of the country.\n- `capital` - The capital of the country.\n- `fips` - The FIPS code of the country.\n- `iso2` - The ISO-3166-alpha-2 code of the country (2-char code, like `US`).\n- `iso3` - The ISO-3166-alpha-3 code of the country (3-char code, like `USA`).\n- `isoNo` - The ISO-3166-num-3 code of the country (3-digit numerical ccode, like `840`).\n- `internet` - The internet code of the country (2-char code, like `US`).\n\n## Which code should I use?\n\nIn general, if you are asked for a two-digit code, use the ISO2 code. If you are asked for a three-digit code, use the\nISO3 code.\n\nThe other code types are provided, but it is likely you will know which code you need based on the context in which you\nare\nasked for it. It's unlikely you will need to use the FIPS code or internet code unless specifically asked for them.\n\n## Roadmap\n\nThis package is a simple utility package and is unlikely to have any major updates. If you have any suggestions or\nfeature requests, please open an issue on GitHub. That said, time permitting, we will likely add the following features:\n\n- Continent-based searches (e.g., get all countries in Europe).\n- Region-based searches (e.g., get all countries in the Middle East).\n- List Continents and Regions.\n- Add more country information (e.g. phone code, currency, etc.).\n    - Searching by these additional fields is likely to be included.\n\n## Versioning\n\nThis package uses [Semantic Versioning](https://semver.org/). For the versions available, see the Releases on this\nrepository.\nDue to the nature of this package, it is unlikely to have any major updates, so the versioning will likely remain at\n1.x.x.\n\nWe maintain semver by utilizing [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) via\nthe [Commit Lint](https://commitlint.js.org/)\npackage. This allows us to automatically generate the version number based on the commit messages, using\nthe [Release Please](https://github.com/googleapis/release-please-action)\nGitHub Action. Due to this, releases are automatically generated when a new commit is pushed to the main branch. The\nrelease is then\npublished to the NPM registry. This could mean that the GitHub release and the NPM package version are not in sync for a\nshort period\nof time.\n\nIf a future utility were to be added that significantly changed the nature of the package, we would likely create a new\npackage with a different name to avoid complicating the existing package.\n\n## Contributing\n\nContributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue on\nGitHub.\n\nFor code contributions, please fork the repository and submit a pull request. Please ensure that your code is\nwell-documented\nand that you have added tests for any new features or bug fixes. While this repository does not have a strict code style\nguide,\nyou should aim to match the existing code style as closely as possible.\n\n## License\n\nThis project is licensed under the MIT License.","readmeFilename":"README.md"}