zuech-dev/addressparser

Usage

AddressParser uses regular expressions to break-down a full address like "88 Colin P Kelly Jr St, San Franciso, CA 94107" into address components. The current tests cover very limited addresses, but I plan to expand the coverage for other address formats. Currently, I'm working on US address formats with the intention of expanding to international formats if there is enough interest.

let parsed = AddressParser.parseAddress("88 Colin P Kelly Jr St, San Franciso, CA 94107")

// Do what you wish with the address components here...

    // Available properties
    // toString() method will yield a standardized representation of the address.
        // IN DEVELOPMENT: string modifiers to return the parsed address in other standardized formats along with a custom option. 
        /* parsed = AddressComponents(
            streetNumber: "88",
            streetName: "Colin P Kelly Jr",
            streetSuffix: "St",
            direction: "",
            unitType: "",
            unitNumber: "",
            city: "San Franciso",
            state: "CA",
            zipcode: "94107"
        ) 
        */

More documentation to come, including the ability to add custom address regex for cases not yet covered by this library. Please open issues for any addresses not covered or parsing correctly. Suggestions should be posted in issues or corrections can be submitted via pull request of a new branch into the (to be created test branch).

Contributing

This project came about from a need at my place of employment, but I welcome additional contributors to make this more robust. For now it's a very simple library with minimal tests. Please feel free to create issues with addresses that don't work with ideas for altering regular expressions for the address.

I will expand on this section with an issue template and instructions for creating pull requests with test requirements.

Package Metadata

Repository: zuech-dev/addressparser

Default branch: main

README: README.md