{"_id":"@ac-dev/cities-service","_rev":"3-10ec6387e38779be058d25e84aee9442","name":"@ac-dev/cities-service","dist-tags":{"latest":"1.1.1"},"versions":{"1.0.0":{"name":"@ac-dev/cities-service","author":{"name":"Alessandro Casazza"},"version":"1.0.0","description":"Get the World's cities","repository":{"type":"git","url":"git+https://github.com/Randagio13/cities-service.git"},"license":"MIT","module":"lib/index.js","typings":"lib/index.d.ts","keywords":["world","countries","states","regions","cities"],"engines":{"node":">=10"},"scripts":{"alias":"npx tsc-alias","start":"tsc --watch","build":"tsc -b tsconfig.json --verbose --force && cp -R data lib","postbuild":"minimize-js lib && npm run minify-json","minify-json":"minify-json ./lib/data -w -s","test":"jest","coverage":"jest --coverage","prepare":"npm run build","size":"size-limit","analyze":"size-limit --why","semantic-release":"semantic-release","publish:beta":""},"publishConfig":{"access":"public"},"release":{"branches":["+([0-9])?(.{+([0-9]),x}).x","main","next","next-major",{"name":"beta","prerelease":true},{"name":"alpha","prerelease":true}],"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/changelog","@semantic-release/npm","@semantic-release/git",["@semantic-release/github",{"addReleases":"top"}]]},"husky":{"hooks":{"pre-commit":"npm run build"}},"prettier":{"printWidth":80,"semi":false,"singleQuote":true,"trailingComma":"es5"},"size-limit":[{"path":"lib","limit":"5 MB","webpack":false}],"devDependencies":{"@babel/preset-env":"^7.16.11","@babel/preset-typescript":"^7.16.7","@semantic-release/changelog":"^6.0.1","@semantic-release/commit-analyzer":"^9.0.2","@semantic-release/git":"^10.0.1","@semantic-release/github":"^8.0.2","@semantic-release/npm":"^9.0.0","@semantic-release/release-notes-generator":"^10.0.3","@types/jest":"^27.4.0","husky":"^7.0.4","jest":"^27.4.7","minify-json":"^1.0.0","minimize-js":"^1.2.0","semantic-release":"^19.0.2","tslib":"^2.3.1","typescript":"^4.5.5"},"gitHead":"74ccf0064a5655de0daec8b142cecf358887937b","bugs":{"url":"https://github.com/Randagio13/cities-service/issues"},"homepage":"https://github.com/Randagio13/cities-service#readme","_id":"@ac-dev/cities-service@1.0.0","_nodeVersion":"14.18.3","_npmVersion":"8.4.1","dist":{"integrity":"sha512-9Pp7EtuvdtOXKCleC/cWTZ5QmMJp9RW9/FEMOYrmg8kIYZ8VMBUIaViEIUMXBTCVqKGOa+Tu+VfcMMGOnSecFA==","shasum":"25a905eec35bec33539103e5aeba4c021f8dc97e","tarball":"https://registry.npmjs.org/@ac-dev/cities-service/-/cities-service-1.0.0.tgz","fileCount":16,"unpackedSize":23063863,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh/7iGCRA9TVsSAnZWagAAU9QP/1kYlkVrCRDHC5pIVYzS\nreyQeAPdG1mYceshJH0eN2u3/wHLw6wGXk0Kp1qhyqz76ktS8N8ZC+f1iKN4\nrfZEKpwc8IWDz6DdvzCuLVhYpfEOTKyrGuXb8EbdxjGcG7SaRd+I6aPlECaq\n0wgmPu7LoOwpiEmIem7MIprX5DKfpSR6aaCx0m9fd1fjQqafKdgyaWdhtg+a\n5UiAj157dDSAIp76yWdaQzEaF5/NUMjsgtmyHsaaVgE7z9lX6DmuOUf/g6Ft\nybB7cQ99SFrtnMdlJcsXnKA3/XXBymyCZ1urLJtnFQUPTNHGk1Z+dNCsG8fM\nWTKws+MrtdZJ+wNsE+n9cWAZgCGtvUAwlq0sdloADa3k0G8JhB6Pc+KPNZpO\n15u49oZ6IaUCBbAamlXD+B72WfKERb/frBENwHlkrGAP2F3PqF2Uwa74Tzzw\nppuS723bPi9pQxvrCVCZA74phZnoRaRodNZeqePExfaY0OxhOBAA4XZu0QMs\nm/WzvJsP4cMyAi69XmWg4mQD/6AaqkYb8zV55So4erisPfFmfeu7OtZOyU6U\nu5AwVqySDzv061czt+MuCD6vGyVTdun/8qv7ENu50mNzAz+/bkMoTQBpU9Zm\ns91yz5vzMKEmmaj4WSvqoB7I2WiGk0lw1v0RKBYxl4YBdQNGTJzBAedBtLBO\nDsXJ\r\n=mi0g\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD4UW8SqW56GHZv4fbxCfgHOI9vTNnfamk6sLngP53qNAIgNu44/f0uRYCiARCTx3v3jsEhyRa5WUmI11yX1CaEbKU="}]},"_npmUser":{"name":"randagio13","email":"alessandro.casazza@icloud.com"},"directories":{},"maintainers":[{"name":"randagio13","email":"alessandro.casazza@icloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cities-service_1.0.0_1644148870530_0.30667354280267856"},"_hasShrinkwrap":false},"1.1.0":{"name":"@ac-dev/cities-service","author":{"name":"Alessandro Casazza"},"version":"1.1.0","description":"Get the World's cities","repository":{"type":"git","url":"git+https://github.com/Randagio13/cities-service.git"},"license":"MIT","module":"lib/index.js","typings":"lib/index.d.ts","keywords":["world","countries","states","regions","cities"],"engines":{"node":">=10"},"scripts":{"alias":"npx tsc-alias","start":"tsc --watch","build":"npm run lint && tsc -b tsconfig.json tsconfig.cjs.json --verbose --force && cp -R data lib","postbuild":"minimize-js lib -w -s -d && npm run minify-json","minify-json":"minify-json ./lib/data","test":"jest","coverage":"jest --coverage","prepare":"npm run build","semantic-release":"semantic-release","lint":"eslint src"},"publishConfig":{"access":"public"},"release":{"branches":["+([0-9])?(.{+([0-9]),x}).x","main","next","next-major",{"name":"beta","prerelease":true},{"name":"alpha","prerelease":true}],"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/changelog","@semantic-release/npm","@semantic-release/git",["@semantic-release/github",{"addReleases":"top"}]]},"husky":{"hooks":{"pre-commit":"npm run build"}},"prettier":{"printWidth":80,"semi":false,"singleQuote":true,"trailingComma":"es5"},"size-limit":[{"path":"lib","limit":"5 MB","webpack":false}],"devDependencies":{"@babel/preset-env":"^7.16.11","@babel/preset-typescript":"^7.16.7","@semantic-release/changelog":"^6.0.1","@semantic-release/commit-analyzer":"^9.0.2","@semantic-release/git":"^10.0.1","@semantic-release/github":"^8.0.2","@semantic-release/npm":"^9.0.1","@semantic-release/release-notes-generator":"^10.0.3","@types/jest":"^27.4.1","@typescript-eslint/eslint-plugin":"^5.16.0","@typescript-eslint/parser":"^5.16.0","eslint":"^8.11.0","husky":"^7.0.4","jest":"^27.5.1","minify-json":"^1.0.0","minimize-js":"^1.3.0","semantic-release":"^19.0.2","tslib":"^2.3.1","typescript":"^4.6.2"},"gitHead":"a1935ec5ff32a40e5ec9afb37f20cb2186a7738d","bugs":{"url":"https://github.com/Randagio13/cities-service/issues"},"homepage":"https://github.com/Randagio13/cities-service#readme","_id":"@ac-dev/cities-service@1.1.0","_nodeVersion":"17.8.0","_npmVersion":"8.4.1","dist":{"integrity":"sha512-ihQ9/OE2gYnsUGcJFhYLmz3JWSYMMdMMYAH+8ARj1rZHXm6U22ollbmA58NEZ/OiPBw+abNmItzcSjS/AHacOQ==","shasum":"80effb5551b5627aa54164a885ce3c96fe1e68d5","tarball":"https://registry.npmjs.org/@ac-dev/cities-service/-/cities-service-1.1.0.tgz","fileCount":40,"unpackedSize":23074409,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiOh54ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrnlw/9EgJS+ZTEu+ECG6UkI40+8hYRY8jwC9TCek9k0+h4KzowdT9w\r\nwQ+p3Y68wNURlDGPJkERqzihMUohKtCXf7dB7ScuAdt0pUKW/bEEI8f8+E8n\r\n+/pk3C78BL5yTT95X+wIiw8WuTSLm1Yr9m1nU26z35WDi5fgYdJBYbJQlZIz\r\n2Si7IFxd5KTdCNs4j7bdIY/l4LAoNOdDs0C+5wMTiz91b+WDJQz0FnuCC8Fn\r\nvRFEKS0dqU4JyXuFHwSHMo0thrXFAhlnS5opFd2lBFbO7EyIy7tnkXi+17MH\r\nfLGPixNgb4B1QEte6Yei5fyzGRgnfSc7eJXo04HxtECZ/nSlLEMMrmJrwvT4\r\n+EmsDgu3w0dltPQgrykNI1LmWB6eomdQh7jTWdWqTmU+XAqOH5I930tqIY3f\r\nc/FR/EmtDCJrRfXe7UGqV4wM0yMNhKQ/O1YAW89NzC/Xwjloyxm6FLeqkg9P\r\n+YNT/C3fV99Fzu8TOVv7AzIXG3aLBtIsMcnCOzkRiCWL6fedKaUc+fKDaMb0\r\nSjOWBura+w+GOor9MF6dKkwfkBM/qO+Glxv8iTmyqgPiz2vQoHvgwvpuhLr9\r\n/bTSVOcspDLb7ALAOz0JohkcipONSUYhKePvvXvJR3ZqHnHJRPhPt3LeP9Oj\r\nilwRUiK3jomv5vRtOC7kBS1q1tjy8F8aBIg=\r\n=LQD4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG83nOxRH+Xc3QOQqRiMVGvEOt/K001fCBGM5GuVoFwXAiEAx/jt5umR6ca8kIEt5VoiGRVG5p6aiL0rPzM8tlAsp/g="}]},"_npmUser":{"name":"randagio13","email":"alessandro.casazza@icloud.com"},"directories":{},"maintainers":[{"name":"randagio13","email":"alessandro.casazza@icloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cities-service_1.1.0_1647976056223_0.5362053097604991"},"_hasShrinkwrap":false},"1.1.1":{"name":"@ac-dev/cities-service","author":{"name":"Alessandro Casazza"},"version":"1.1.1","description":"Get the World's cities","repository":{"type":"git","url":"git+https://github.com/Randagio13/cities-service.git"},"license":"MIT","main":"lib/cjs/index.js","module":"lib/esm/index.js","typings":"lib/esm/index.d.ts","keywords":["world","countries","states","regions","cities"],"engines":{"node":">=10"},"scripts":{"alias":"npx tsc-alias","start":"tsc --watch","build":"npm run lint && tsc -b tsconfig.json tsconfig.cjs.json --verbose --force && cp -R data lib","postbuild":"minimize-js lib -w -s -d && npm run minify-json","minify-json":"minify-json ./lib/data","test":"jest","coverage":"jest --coverage","prepare":"npm run build","semantic-release":"semantic-release","lint":"eslint src"},"publishConfig":{"access":"public"},"release":{"branches":["+([0-9])?(.{+([0-9]),x}).x","main","next","next-major",{"name":"beta","prerelease":true},{"name":"alpha","prerelease":true}],"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/changelog","@semantic-release/npm","@semantic-release/git",["@semantic-release/github",{"addReleases":"top"}]]},"husky":{"hooks":{"pre-commit":"npm run build"}},"prettier":{"printWidth":80,"semi":false,"singleQuote":true,"trailingComma":"es5"},"size-limit":[{"path":"lib","limit":"5 MB","webpack":false}],"devDependencies":{"@babel/preset-env":"^7.16.11","@babel/preset-typescript":"^7.16.7","@semantic-release/changelog":"^6.0.1","@semantic-release/commit-analyzer":"^9.0.2","@semantic-release/git":"^10.0.1","@semantic-release/github":"^8.0.2","@semantic-release/npm":"^9.0.1","@semantic-release/release-notes-generator":"^10.0.3","@types/jest":"^27.4.1","@typescript-eslint/eslint-plugin":"^5.16.0","@typescript-eslint/parser":"^5.16.0","eslint":"^8.11.0","husky":"^7.0.4","jest":"^27.5.1","minify-json":"^1.0.0","minimize-js":"^1.3.0","semantic-release":"^19.0.2","tslib":"^2.3.1","typescript":"^4.6.2"},"gitHead":"dc66c914522e97e98c71fb073c615018ee0f291a","bugs":{"url":"https://github.com/Randagio13/cities-service/issues"},"homepage":"https://github.com/Randagio13/cities-service#readme","_id":"@ac-dev/cities-service@1.1.1","_nodeVersion":"17.8.0","_npmVersion":"8.4.1","dist":{"integrity":"sha512-rsQRe6DS6MacA7h5lnD3wt65qfDPVU0tuSC3i0Xj+6ANpCvAHy41XoJpMp66k8Q97YHz8y9cKylD5r3NnSumyA==","shasum":"ab6a64b8deca49e5a2c9f0e933c131f45e5f2e50","tarball":"https://registry.npmjs.org/@ac-dev/cities-service/-/cities-service-1.1.1.tgz","fileCount":40,"unpackedSize":23074447,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiOiOvACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpgpA//cbSXyyZOSrms6KrzOvTbQbdZSomrcyqAPgfQwEG9lorIPNZt\r\nDkinLmlppwQ8kJ0G2Px6HGGhv7/tRYDZUNOiZmuJoJotkwGk5oy/zwjW92u6\r\nqmIsFbnHGjIrxGDXfP/ysMBrp8pD4M6aehXcQ+3zt6wT+gj4XkX6xXYjtRya\r\nC3dHOezh0Tp02a8FJRFZKNahHL0WN8fOTVF4RDKw+JWTe1aB0efoj12oOj7c\r\nQsp3OSZyOehLvRvmNRB3s7QSLrnBavjoSyrNt0ue30Iv6pUcN3BAmsj8BHt4\r\neSVKoiRAio6xeHdzJPho8iWYJmQJxdllO1nGnaBomhqyCBj3zrV3FmFDIFHR\r\nBxKrL1aAyxLiU0QIfxhVAE5eiBHHOJl/Bqt62VpvlYnNFKP3/eL7EGuvwiZC\r\nYyc98P8urnM18BB+51gxuPjfImXDva2tTqyL+Yr+VLk7pyT1L7dF2IIjqK0r\r\noMwVnMScr0vFn2nx4IKqMaJuDd/tmDSgQJHBTEbO5Ixh9YwVXD03aj6cqe/H\r\nVWw3S5Gy6tazxtLgx1F77/bxMG6IowwOZBiaHxtKf8CkgbmjbqIFrP360RLs\r\nw+wMh5OpKsKATWK4q5ZWJcBLUYWQbSsrrKLR+tNYpplZaMJfG/kbx+507ZCr\r\nf5UvtdXA+99U2z55o4eshSBaxRMWf7o8fVM=\r\n=L44r\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDKhAdEeVtM9mKh+S6yA+kHMSrIEX4qEXA8spGeshFl9AiEA97mbw1IKVbrF9BDrXtJ4s/0g7rBu9Q3r1bck40ICh+E="}]},"_npmUser":{"name":"randagio13","email":"alessandro.casazza@icloud.com"},"directories":{},"maintainers":[{"name":"randagio13","email":"alessandro.casazza@icloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cities-service_1.1.1_1647977391361_0.1092332902504407"},"_hasShrinkwrap":false}},"time":{"created":"2022-02-06T12:01:10.468Z","1.0.0":"2022-02-06T12:01:10.800Z","modified":"2022-04-04T11:04:37.646Z","1.1.0":"2022-03-22T19:07:36.451Z","1.1.1":"2022-03-22T19:29:51.692Z"},"maintainers":[{"name":"randagio13","email":"alessandro.casazza@icloud.com"}],"description":"Get the World's cities","homepage":"https://github.com/Randagio13/cities-service#readme","keywords":["world","countries","states","regions","cities"],"repository":{"type":"git","url":"git+https://github.com/Randagio13/cities-service.git"},"author":{"name":"Alessandro Casazza"},"bugs":{"url":"https://github.com/Randagio13/cities-service/issues"},"license":"MIT","readme":"<div align=\"center\">\n  \n# Countries Service\n\n[![NPM](https://nodei.co/npm/@ac-dev/cities-service.png?compact=true)](https://nodei.co/npm/@ac-dev/cities-service/)\n<br />\n[![](https://img.shields.io/npm/dt/@ac-dev/cities-service.svg?style=flat-square)](https://www.npmjs.com/package/@ac-dev/countries-service)\n\n</div>\n\n## Table of contents\n\n1. [Mission](#mission)\n2. [Getting started](#getting-started)\n   - [Installation](#installation)\n   - [Import](#import)\n3. [Usage](#usage)\n4. [Contributors](#contributors)\n5. [Need help](#need-help)\n6. [Licence](#license)\n7. [Sponsor](#sponsor)\n\n## Mission\n\n- I've never found any complete library to get all world countries, states, and cities. I want to develop the best one. Of course, contributors are welcome!!\n- I took this [data](https://github.com/dr5hn/countries-states-cities-database) as a starting point.\n- This package is a part of [countries-states-cities-service](https://github.com/Randagio13/countries-states-cities-service)\n\n## Getting started\n\nTo get started with this library, you need to install it and add it to your project.\n\n### Installation\n\nCities Service is available as an npm package.\n\n```bash\n# npm\nnpm install @ac-dev/cities-service\n\n# yarn\nyarn add @ac-dev/cities-service\n```\n\n### Import\n\nImport single named import as follow:\n\n```typescript\nimport { Cities } from '@ac-dev/cities-service'\n```\n\n## Usage\n\nThe code snippet below shows how to put into action `cities-service` in some common use cases.\n\n- Get all cities.\n\n```typescript\nconst cities = Cities.getCities()\n```\n\n- Get all cities by `asc` sort.\n\n```typescript\nconst cities = Cities.getCities({\n  sort: {\n    mode: 'asc',\n  },\n})\n```\n\n- Get all cities by `desc` sort.\n\n```typescript\nconst cities = Cities.getCities({\n  sort: {\n    mode: 'desc',\n  },\n})\n```\n\n- Get all cities by `alphabetical` sort.\n\n```typescript\nconst cities = Cities.getCities({\n  sort: {\n    mode: 'alphabetical',\n    key: 'name',\n  },\n})\n```\n\n- Get Italian cities.\n\n```typescript\nconst cities = Cities.getCities({\n  filters: {\n    country_code: 'IT',\n  },\n})\n```\n\n- Get Italian and French cities.\n\n```typescript\nconst cities = Cities.getCities({\n  filters: {\n    country_code: ['IT', 'FR'],\n  },\n})\n```\n\n- Get Italian Ligurian cities.\n\n```typescript\nconst cities = Cities.getCities({\n  filters: {\n    country_code: 'IT',\n    state_code: '42', // Region iso2\n  },\n})\n```\n\n## Contributors\n\nAny contribution is appreciated. You can get started with the steps below:\n\n1. Fork [this repository](https://github.com/Randagio13/countries-states-cities-service) (learn how to do this [here](https://help.github.com/articles/fork-a-repo)).\n\n2. Clone the forked repository.\n\n3. Make your changes and create a pull request ([learn how to do this](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)).\n\n4. I will attend to your pull request and provide some feedback.\n\n## Need help?\n\nPing me [on Twitter](https://twitter.com/randagio19)\n\n## License\n\nThis repository is licensed under the [MIT](LICENSE) License.\n\n## Sponsor\n\nDon't be shy! 😜\n\n[:heart: Sponsor](https://github.com/sponsors/Randagio13)\n","readmeFilename":"README.md"}