{"analyzedAt":"2022-07-14T07:16:52.071Z","collected":{"metadata":{"name":"@creadi/swiss-zipcodes","scope":"creadi","version":"1.0.1","description":"Swiss zip codes","keywords":["Swiss","zipcode","postcode","PLZ","NPA"],"date":"2018-01-23T07:33:22.972Z","author":{"name":"creadi"},"publisher":{"username":"idris-maps","email":"idris.maps@gmx.ch"},"maintainers":[{"username":"stophecom","email":"kingchiller@gmail.com"},{"username":"cauboom","email":"developer@creadi.ch"},{"username":"idris-maps","email":"idris.maps@gmx.ch"},{"username":"cauboy","email":"clemens.dev@mcm-init.com"}],"repository":{"type":"git","url":"git+https://github.com/creadi/swiss-zipcodes.git"},"links":{"npm":"https://www.npmjs.com/package/%40creadi%2Fswiss-zipcodes","homepage":"https://github.com/creadi/swiss-zipcodes#readme","repository":"https://github.com/creadi/swiss-zipcodes","bugs":"https://github.com/creadi/swiss-zipcodes/issues"},"license":"MIT","dependencies":{"lodash.filter":"^4.6.0"},"devDependencies":{"@types/lodash.filter":"^4.6.3","tap-spec":"^4.1.1","tape":"^4.8.0","ts-node":"^3.3.0","typescript":"^2.6.1"},"releases":[{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":1},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":1},{"from":"2020-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":1}],"hasTestScript":true,"readme":"[![GitHub issues](https://img.shields.io/github/issues/badges/shields.svg)](https://github.com/creadi/swiss-zipcodes)\n[![npm](https://img.shields.io/npm/l/express.svg)](https://github.com/creadi/swiss-zipcodes)\n[![Build Status](https://travis-ci.org/creadi/swiss-zipcodes.svg?branch=master)](https://travis-ci.org/creadi/swiss-zipcodes)\n\n# swiss-zipcodes\n\n## Purpose\n\nSearch and validate swiss zip codes\n\n## Usage\n\n```bash\nnpm i --save swiss-zipcodes\n# or\nnpm install https://github.com/creadi/swiss-zipcodes\n```\n\nand\n\n```javascript\nimport { search, validate, cityFromZip } from 'swiss-zipcodes'\n```\n\n### search()\n\nSearch by any combination of:\n  * `zip` (`number`)\n  * `canton` (`string`)\n  * `commune` (`string`)\n\n```javascript\nsearch({ zip: 4054 })\n```\n\nreturns\n\n```javascript\n[\n  {\n    zip: 4054,\n    canton: 'BS',\n    commune: 'Basel'\n  }\n]\n```\n\n### validate()\n\nValidate `zip` code as `number` or `string`\n\n```javascript\nvalidate(4054)\n\n// or\n\nvalidate('4054')\n```\n\nreturns `true`\n\n### cityFromZip()\n\nGet an array of `commune` names from a zip code ( `number` or `string`)\n\n```javascript\ncityFromZip(4052)\n\n// or\n\ncityFromZip('4052')\n```\n\nreturns\n\n```javascript\n[\n  'Basel',\n  'Münchenstein'\n]\n```\n\n## Data\n\nData from Federal Statistics\nhttps://www.bfs.admin.ch/bfs/fr/home/bases-statistiques/repertoire-officiel-communes-suisse/tableau-correspondance-regbl.assetdetail.2861277.html\n\nDirect link to excel sheet\nhttps://www.bfs.admin.ch/bfsstatic/dam/assets/2861277/master"},"npm":{"downloads":[{"from":"2022-07-13T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":2},{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":7},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":26},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":83},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":186}],"starsCount":2},"github":{"starsCount":4,"forksCount":0,"subscribersCount":6,"issues":{"count":10,"openCount":2,"distribution":{"3600":5,"10800":0,"32400":0,"97200":0,"291600":0,"874800":1,"2624400":0,"7873200":2,"23619600":0,"70858800":1,"212576400":1},"isDisabled":false},"contributors":[{"username":"cauboy","commitsCount":5},{"username":"syzer","commitsCount":5},{"username":"idris-maps","commitsCount":29},{"username":"dependabot[bot]","commitsCount":1}],"commits":[{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0}],"statuses":[{"context":"continuous-integration/travis-ci/push","state":"success"}]},"source":{"files":{"readmeSize":1478,"testsSize":4404},"badges":[{"urls":{"original":"https://img.shields.io/npm/l/express.svg","shields":"https://img.shields.io/npm/l/express.svg","content":"https://img.shields.io/npm/l/express.json"},"info":{"service":"npm","type":"license","modifiers":{"type":"l"}}},{"urls":{"original":"https://travis-ci.org/creadi/swiss-zipcodes.svg?branch=master","service":"https://api.travis-ci.org/creadi/swiss-zipcodes.svg?branch=master","shields":"https://img.shields.io/travis/creadi/swiss-zipcodes/master.svg","content":"https://img.shields.io/travis/creadi/swiss-zipcodes/master.json"},"info":{"service":"travis","type":"build","modifiers":{"branch":"master"}}}]}},"evaluation":{"quality":{"carefulness":0.71,"tests":0.85,"health":1,"branding":0.3},"popularity":{"communityInterest":16,"downloadsCount":8.666666666666666,"downloadsAcceleration":-0.0811834094368341,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9,"commitsFrequency":0.9,"openIssues":1,"issuesDistribution":0.9}},"score":{"final":0.6477300687846457,"detail":{"quality":0.9378363677627793,"popularity":0.04689121228051858,"maintenance":0.9999063833075152}}}