swiss-address-parser

parses 🇨🇭 address strings into structured data

⚠️ This project is still in development and not ready for production use. ⚠️
Can't wait to use it? Feel free to contribute.

📝 Table of Contents

• About
• Getting Started
• Installing
• Usage
• License
• Tests
• Built Using
• Authors

🧐 About

swiss-address-parser is a library that parses 🇨🇭 address strings into structured data. It acknowledges the fact that user input varies and tries to parse as much as possible.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

Install the package via npm:

npm install swiss-address-parser --save

or via yarn:

yarn add swiss-address-parser

🎈 Usage

Basic usage

import parse from 'swiss-address-parser';

const address = parse('Musterstrasse 1, 8000 Zürich');

console.log(address);

// {
//   street: 'Musterstrasse',
//   streetNumber: '1',
//   zipCode: '8000',
//   city: 'Zürich',
//   canton: 'ZH',
//   country: 'CH'
// }

📜 License

In the vast realm of code, where ideas intertwine and innovation knows no bounds, I find myself continually amazed by the unwavering spirit of collaboration that defines the open source community. It's a world where developers, like you and me, share their creations, their insights, and their expertise with an unparalleled generosity. Countless times, whether through serendipitous discovery or through meticulous research, I've stumbled upon remarkable projects that have enriched my own journey as a developer.

Recognizing the profound impact that the open source community has had on my own growth, I've made a personal commitment to give back to this tapestry of ingenuity. The code is licensed under the Apache license, which means that you're free to use, remix, and build upon it. It's my way of extending the thread of collaboration that binds us as developers.

🔧 Running the tests

Tests are written with jest. You can run them with the following command:

npm run test

⛏️ Built Using

• TypeScript - Programming language
• Jest - Testing framework
• Prettier - Code formatter
• ESLint - Linter

✍️ Authors

• @cytex-ch - Project author
• @sjutz - Project maintainer simon.jutz@cytex.ch