https://github.com/thecompaniesapi/us-postal-code-to-state-name

Convert your US postal code to the name of the state.
https://github.com/thecompaniesapi/us-postal-code-to-state-name

javascript library

Last synced: 2 months ago
JSON representation

Convert your US postal code to the name of the state.

• Host: GitHub
• URL: https://github.com/thecompaniesapi/us-postal-code-to-state-name
• Owner: thecompaniesapi
• License: mit
• Created: 2020-09-13T15:43:47.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-16T13:09:55.000Z (about 4 years ago)
• Last Synced: 2024-08-08T22:16:10.709Z (almost 2 years ago)
• Topics: javascript, library
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@prospectwith/us-postal-code-to-state-name
• Size: 16.6 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# US Postal Code To State Name

[![npm](https://img.shields.io/npm/v/@prospectwith/us-postal-code-to-state-name.svg)](https://www.npmjs.com/package/@prospectwith/us-postal-code-to-state-name)

[![npm](https://img.shields.io/npm/dm/@prospectwith/us-postal-code-to-state-name.svg)](https://npm-stat.com/charts.html?package=@prospectwith/us-postal-code-to-state-name)

[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/prospectwith/us-postal-code-to-state-name.svg)](http://isitmaintained.com/project/prospectwith/us-postal-code-to-state-name "Average time to resolve an issue")

[![Percentage of issues still open](http://isitmaintained.com/badge/open/prospectwith/us-postal-code-to-state-name.svg)](http://isitmaintained.com/project/prospectwith/us-postal-code-to-state-name "Percentage of issues still open")

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/prospectwith/us-postal-code-to-state-name/blob/master/LICENSE)

## Installation

```

npm install @prospectwith/us-postal-code-to-state-name

# Or if you prefer using yarn

yarn add @prospectwith/us-postal-code-to-state-name

```

### Imports

```js

const { convertPostalCodeToStateName } = require("@prospectwith/us-postal-code-to-state-name")

convertPostalCodeToStateName("al") // Will output Alabama

const { data } = require("@prospectwith/us-postal-code-to-state-name")

console.log(data) // Will output the full data object with all postal codes, abbreviations and state names

```

## Contributing

You are more than welcome to contribute to this package. Just submit changes via pull request and I will review them before merging.

1. Fork it! 🤙

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am "Add some feature"`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request 👍

## License

This package is [MIT licensed](LICENSE).