{"_id":"@bvenceslas/african-countries","_rev":"1-452c1b69e2c6e4c91db74b6d11f67cd7","name":"@bvenceslas/african-countries","description":"A lightweight npm package providing information about African countries.","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.1":{"name":"@bvenceslas/african-countries","version":"1.0.1","keywords":["african countries","african countries information","geography","data","npm package","javascript"],"author":{"name":"bvenceslas","email":"bvenceslas@gmail.com"},"license":"MIT","_id":"@bvenceslas/african-countries@1.0.1","homepage":"https://github.com/bvenceslas/african-countries#readme","bugs":{"url":"https://github.com/bvenceslas/african-countries/issues"},"dist":{"shasum":"2971fe2313ab72fb431755836a2029c0a615d8db","tarball":"https://registry.npmjs.org/@bvenceslas/african-countries/-/african-countries-1.0.1.tgz","fileCount":5,"integrity":"sha512-L56H5JPjeARPxlxysx+psBkiRzBodaioRX0DymV6EQ157dzHVVk6HByylpanyrwiEVPnSoqiBbWm0jxvLiyysQ==","signatures":[{"sig":"MEUCIQDfKb97FiTAm3m44OKaiboRzNW4MHGjumt7m3EIKeFXCgIgJCIqxVRyNHOHDQZcZde1B25GZfdV7uzWkTI2K9HA6xI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":30721},"main":"index.js","gitHead":"a6b58ad9b249a780c8c1f96398fcb233a1c44bd8","_npmUser":{"name":"bvenceslas","email":"bvenceslas@gmail.com"},"repository":{"url":"git+https://github.com/bvenceslas/african-countries.git","type":"git"},"_npmVersion":"10.5.0","description":"A lightweight npm package providing information about African countries.","directories":{},"_nodeVersion":"18.20.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/african-countries_1.0.1_1719743755309_0.9183662926181044","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@bvenceslas/african-countries","description":"A lightweight npm package providing information about African countries.","keywords":["african countries","african countries information","geography","data","npm package","javascript"],"version":"1.0.2","main":"index.js","types":"index.d.ts","repository":{"type":"git","url":"git+https://github.com/bvenceslas/african-countries.git"},"author":{"name":"bvenceslas","email":"bvenceslas@gmail.com"},"license":"MIT","_id":"@bvenceslas/african-countries@1.0.2","gitHead":"07ee9d09cc984cf3ddb5fa325e57c41cda9785ce","bugs":{"url":"https://github.com/bvenceslas/african-countries/issues"},"homepage":"https://github.com/bvenceslas/african-countries#readme","_nodeVersion":"18.20.1","_npmVersion":"10.5.0","dist":{"integrity":"sha512-VxYxu3Zlw20bFmTN5d4RXKa9hqzZTXBLsux6dWKBDzsiFyMC5os3bcKyeDS8oWR55YK4SI6k0via8NNLH1Vydw==","shasum":"0a62b1482d69927d48b7154188b1d75e028d8fc8","tarball":"https://registry.npmjs.org/@bvenceslas/african-countries/-/african-countries-1.0.2.tgz","fileCount":5,"unpackedSize":30543,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBFrae4SYuY6GuYcODHNCNj/1gqxQiNC3A5tZ2k0QLIqAiArWKdDox39S0oI6CzNFE6nxLS1MKAhiafPVYovBgKTlA=="}]},"_npmUser":{"name":"bvenceslas","email":"bvenceslas@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/african-countries_1.0.2_1719919667488_0.6740826062625525"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-30T10:35:55.182Z","modified":"2024-07-02T11:27:47.765Z","1.0.1":"2024-06-30T10:35:55.470Z","1.0.2":"2024-07-02T11:27:47.620Z"},"maintainers":[{"name":"bvenceslas","email":"bvenceslas@gmail.com"}],"author":{"name":"bvenceslas","email":"bvenceslas@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/bvenceslas/african-countries.git"},"keywords":["african countries","african countries information","geography","data","npm package","javascript"],"license":"MIT","homepage":"https://github.com/bvenceslas/african-countries#readme","bugs":{"url":"https://github.com/bvenceslas/african-countries/issues"},"readme":"# African Countries Info NPM Package\n\nA lightweight npm package providing information about African countries. It includes functions to fetch, search, filter, and aggregate country data.\n\n## Installation\n\nYou can install this package using npm or yarn:\n\n```sh\nnpm install @bvenceslas/african-countries\n```\n\nOr using **yarn**:\n\n```sh\nyarn add @bvenceslas/african-countries\n```\n\n## Usage\n\nImport the package in your JavaScript/TypeScript file:\n\n```bash\n// ES6\n\nimport {\n  getCountries,\n  getCountriesCount,\n  getCountriesNamesAndAcronym,\n  searchCountry,\n  filterCountriesByContinent,\n  getCountryDetailsByCode,\n  getTotalCountriesPopulation,\n  getTotalCountriesArea,\n} = from \"@bvenceslas/african-countries\";\n\n\n// ES5\nconst {\n  getCountries,\n  getCountriesCount,\n  getCountriesNamesAndAcronym,\n  searchCountry,\n  filterCountriesByContinent,\n  getCountryDetailsByCode,\n  getTotalCountriesPopulation,\n  getTotalCountriesArea,\n} = require(\"@bvenceslas/african-countries\");\n\nconsole.log(getCountriesCount()); // Output: total number of countries\n\nconsole.log(getCountriesNamesAndAcronym(\"english\")); // Output: sorted list of country names and acronyms in English\n\nconsole.log(getCountryDetailsByCode(\"+255\")); // Output: details of the country with code +255\n\n```\n\n## Functions\n\n### `getCountries()`\n\nReturns an array of country objects.\n\n### `getCountriesCount()`\n\nReturns the total number of countries.\n\n### `getCountriesNamesAndAcronym(sortBy)`\n\nReturns an array of country names and acronyms sorted by the specified key (default is \"english\").\n\n### `searchCountry(query)`\n\nSearches for countries by name or acronym and returns an array of matching countries.\n\n### `filterCountriesByContinent(continent)`\n\nFilters countries by the specified continent and returns an array of countries.\n\n### `getCountryDetailsByCode(code)`\n\nReturns detailed information about a country by its code or null if not found.\n\n### `getTotalCountriesPopulation()`\n\nReturns the total population of all countries.\n\n### `getTotalCountriesArea()`\n\nReturns the total area of all countries.\n\n## Contributing\n\nContributions are welcome! Feel free to open issues or submit pull requests.\n\n## License\n\nThis package is licensed under the MIT License.\n\nThe country data is sourced from the ISO (International Organization for Standardization).\n\n## Roadmap\n\nFuture updates may include country flags, official language (specified), etc ..\n\n## Author\n\n👤 Venceslas BURONGU\n\n- Github: @bvenceslas [@bvenceslas](https://github.com/bvenceslas)\n- Twitter: [@bvenceslas](https://twitter.com/bvenceslas)\n- Linkedin: [Venceslas Burongu](https://www.linkedin.com/in/venceslas-burongu/)\n\n## Show your support\n\nGive a ⭐️ if you like this project!\n","readmeFilename":"README.md"}