swiss-address-parser

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
• Tests
• Usage
• 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'
// }

🔧 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 [e-mail]