postal

README

go-postal

Minimalistic library for keeping up to date with Postal (Zip) Code checks and US state finder/parser.

Installation

go get github.com/lawzava/go-postal

Usage

package main

import "github.com/lawzava/go-postal"

func main() {
	postal.IsValid("70100") // true
	postal.IsValid("101023") // false
}

Documentation

Index

• Constants
• Variables
• func IsValid(code string) bool
• type State
  • func FindState(postal string) (State, error)
  • func (s State) Is(state State) bool
  • func (s State) Name() StateName
  • func (s State) String() string
• type StateName
  • func (s StateName) String() string

Constants

const (
	Alaska     State     = "AK"
	AlaskaName StateName = "Alaska"

	Alabama     State     = "AL"
	AlabamaName StateName = "Alabama"

	Arkansas     State     = "AR"
	ArkansasName StateName = "Arkansas"

	Arizona     State     = "AZ"
	ArizonaName StateName = "Arizona"

	California     State     = "CA"
	CaliforniaName StateName = "California"

	Colorado     State     = "CO"
	ColoradoName StateName = "Colorado"

	Connecticut     State     = "CT"
	ConnecticutName StateName = "Connecticut"

	WashingtonDC     State     = "DC"
	WashingtonDCName StateName = "Washington DC"

	Delaware     State     = "DE"
	DelawareName StateName = "Delaware"

	Florida     State     = "FL"
	FloridaName StateName = "Florida"

	Georgia     State     = "GA"
	GeorgiaName StateName = "Georgia"

	Hawaii     State     = "HI"
	HawaiiName StateName = "Hawaii"

	Iowa     State     = "IA"
	IowaName StateName = "Iowa"

	Idaho     State     = "ID"
	IdahoName StateName = "Idaho"

	Illinois     State     = "IL"
	IllinoisName StateName = "Illinois"

	Indiana     State     = "IN"
	IndianaName StateName = "Indiana"

	Kansas     State     = "KS"
	KansasName StateName = "Kansas"

	Kentucky     State     = "KY"
	KentuckyName StateName = "Kentucky"

	Louisiana     State     = "LA"
	LouisianaName StateName = "Louisiana"

	Massachusetts     State     = "MA"
	MassachusettsName StateName = "Massachusetts"

	Maryland     State     = "MD"
	MarylandName StateName = "Maryland"

	Maine     State     = "ME"
	MaineName StateName = "Maine"

	Michigan     State     = "MI"
	MichiganName StateName = "Michigan"

	Minnesota     State     = "MN"
	MinnesotaName StateName = "Minnesota"

	Missouri     State     = "MO"
	MissouriName StateName = "Missouri"

	Mississippi     State     = "MS"
	MississippiName StateName = "Mississippi"

	Montana     State     = "MT"
	MontanaName StateName = "Montana"

	NorthCarolina     State     = "NC"
	NorthCarolinaName StateName = "North Carolina"

	NorthDakota     State     = "ND"
	NorthDakotaName StateName = "North Dakota"

	Nebraska     State     = "NE"
	NebraskaName StateName = "Nebraska"

	NewHampshire     State     = "NH"
	NewHampshireName StateName = "New Hampshire"

	NewJersey     State     = "NJ"
	NewJerseyName StateName = "New Jersey"

	NewMexico     State     = "NM"
	NewMexicoName StateName = "New Mexico"

	Nevada     State     = "NV"
	NevadaName StateName = "Nevada"

	NewYork     State     = "NY"
	NewYorkName StateName = "New York"

	Ohio     State     = "OH"
	OhioName StateName = "Ohio"

	Oklahoma     State     = "OK"
	OklahomaName StateName = "Oklahoma"

	Oregon     State     = "OR"
	OregonName StateName = "Oregon"

	Pennsylvania     State     = "PA"
	PennsylvaniaName StateName = "Pennsylvania"

	RhodeIsland     State     = "RI"
	RhodeIslandName StateName = "Rhode Island"

	SouthCarolina     State     = "SC"
	SouthCarolinaName StateName = "South Carolina"

	SouthDakota     State     = "SD"
	SouthDakotaName StateName = "South Dakota"

	Tennessee     State     = "TN"
	TennesseeName StateName = "Tennessee"

	Texas     State     = "TX"
	TexasName StateName = "Texas"

	Utah     State     = "UT"
	UtahName StateName = "Utah"

	Virginia     State     = "VA"
	VirginiaName StateName = "Virginia"

	Vermont     State     = "VT"
	VermontName StateName = "Vermont"

	Washington     State     = "WA"
	WashingtonName StateName = "Washington"

	Wisconsin     State     = "WI"
	WisconsinName StateName = "Wisconsin"

	WestVirginia     State     = "WV"
	WestVirginiaName StateName = "West Virginia"

	Wyoming     State     = "WY"
	WyomingName StateName = "Wyoming"
)

Variables

var (
	// ErrInvalidCode defines an error when the supplied code is not valid.
	ErrInvalidCode = errors.New("supplied code is invalid")

	// ErrStateNotFound defines an error when the supplied code did not match any of the US states.
	ErrStateNotFound = errors.New("state not found by supplied code")
)

Functions

func IsValid

func IsValid(code string) bool

IsValid checks whether the supplied request is valid postal code.

Types

type State

type State string

State defines US State short code.

func FindState

func FindState(postal string) (State, error)

FindState returns the state by postal code. Returns ErrStateNotFound if state was not found. Returns ErrInvalidCode if the provided code was not valid.

func (State) Is

func (s State) Is(state State) bool

Is will compare the state.

func (State) Name

func (s State) Name() StateName

Name returns full state name from state code.

func (State) String

func (s State) String() string

String returns string version of State.

type StateName

type StateName string

StateName defines full name of the US State.

func (StateName) String

func (s StateName) String() string

String returns string version of StateName.