UNPKG

us-states-normalize

Version:

A library to normalize and convert any variations of US state names and abbreviations.

github.com/batashi/us-states-normalize

batashi/us-states-normalize

134 lines (112 loc) • 2.76 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# us-states-normalize A library to normalize and convert any variations of US state names and abbreviations. ## Installation ``` npm install us-states-normalize --save ``` ## Usage ``` var normalize = require('us-states-normalize'); // using original 50 states + D.C. normalize('Alabama'); // 'AL' normalize('N.Y.'); // 'NY' normalize('WashingTON DC'); // 'DC' normalize('Puerto Rico'); // null - not a state // to include territories as well such as Guam normalize('US Virgin Islands', { region: ['state', 'territory'] }); // 'VI' // to include everything including freely associated states normalize('Micronesia', { region: 'all' }); // 'FM' // to return full names normalize('RI', { returnType: 'name' }); // 'Rhode Island' // to return customized names normalize('DC', { // 'Washington DC' returnType: function(states) { // states is a key:value store with keys as USPS codes and values as the full names states['DC'] = 'Washington DC'; // default was { "DC": "District Of Columbia" } return states; } }); // to omit certain states normalize('DC', { omit: ['DC'] }); // null ``` The options along with their defaults: ``` { region: [String|Array]('state') - ['state', 'territory', 'associated'] returnType: [String|Function]('USPS') - ['USPS', 'AP', 'name', function(states) {}] omit: [String|Array](null) - list of USPS codes } ``` ## Test ``` npm test ``` ## US States and Territories ### States ``` AL - Alabama AK - Alaska AZ - Arizona AR - Arkansas CA - California CO - Colorado CT - Connecticut DE - Delaware DC - District Of Columbia FL - Florida GA - Georgia HI - Hawaii ID - Idaho IL - Illinois IN - Indiana IA - Iowa KS - Kansas KY - Kentucky LA - Louisiana ME - Maine MD - Maryland MA - Massachusetts MI - Michigan MN - Minnesota MS - Mississippi MO - Missouri MT - Montana NE - Nebraska NV - Nevada NH - New Hampshire NJ - New Jersey NM - New Mexico NY - New York NC - North Carolina ND - North Dakota OH - Ohio OK - Oklahoma OR - Oregon PA - Pennsylvania RI - Rhode Island SC - South Carolina SD - South Dakota TN - Tennessee TX - Texas UT - Utah VT - Vermont VA - Virginia WA - Washington WV - West Virginia WI - Wisconsin WY - Wyoming ``` ### Territories ``` AS - American Samoa GU - Guam MP - Northern Mariana Islands PR - Puerto Rico VI - Virgin Islands ``` ### Freely Associated States ``` FM - Federated States Of Micronesia MH - Marshall Islands PW - Palau ```