usa-state-validator
A tool to determine whether a given input is a valid name or abbreviation of a USA state.
Install
npm install usa-state-validator
Usage
isValidStateInput(textInput)
This method accepts an input value and returns true if the input is a valid USA state name or abbreviation. It will:
- return true regardless of case
- return false if the input is not a string
- return true if the input has leading or trailing spaces
- return false if the input is not a state abbreviation or a state name
const isValidStateInput = // true // true // true // true // true // false // false // false
isValidStateName(textInput)
This method accepts an input value and returns true if the input is a valid USA state name. It will:
- return true regardless of case
- return false if the input is not a string
- return true if the input has leading or trailing spaces
- return false if the input is not a state abbreviation
const isValidStateName = // true // true // true // true // false // false // false // false // false
isValidStateAbbreviation(textInput)
This method accepts an input value and returns true if the input is a valid USA state abbreviation. It will:
- return true regardless of case
- return false if the input is not a string
- return true if the input has leading or trailing spaces
- return false if the input is not a state abbreviation
const isValidStateAbbreviation = // true // true // true // false // false // false // false // false // false // false
isValidStateCapital(textInput)
This method accepts an input value and returns true if the input is a valid USA state capital. It will:
- return true regardless of case
- return false if the input is not a string
- return true even if the input has leading or trailing spaces
- return false if the input is not a state capital
const isValidStateCapital = // true // true // true // false // false // false // false // false // false
retrieveStateInformation(textInput)
This method accepts an input value of a state name, abbreviation, or capital city and returns the formatted state name, capital, and abbreviation as a JSON object if the input is a valid USA state abbreviation or name. It will:
- return the formatted object regardless of the case of the input
- return null if the input is not a string or if the input is not a valid state name or abbreviation
- return the formatted object if the input has leading or trailing spaces
const retrieveStateInformation = //returns {abbreviation: "OH", name: "Ohio", capital: "Columbus" } //returns {abbreviation: "OH", name: "Ohio", capital: "Columbus" } //returns {abbreviation: "OH", name: "Ohio", capital: "Columbus" } //returns {abbreviation: "OH", name: "Ohio", capital: "Columbus" } //returns {abbreviation: "OH", name: "Ohio", capital: "Columbus" } //returns {abbreviation: "OH", name: "Ohio", capital: "Columbus" } //returns {abbreviation: "OH", name: "Ohio", capital: "Columbus" } //returns null //returns null //returns null
retrieveStateCapitalByName(stateName)
This method accepts an input value of a state name and returns the formatted capital as a String. It will:
- return the formatted object regardless of the case of the input
- return null if the input is not a string or if the input is not a valid state name
- return the formatted capital if the input has leading or trailing spaces
const retrieveStateCapitalByName = //returns "Columbus" //returns null //returns null
retrieveStateNameByCapital(stateName)
This method accepts an input value of a state capital and returns the formatted state name as a String. It will:
- return the formatted object regardless of the case of the input
- return null if the input is not a string or if the input is not a valid state capital
- return the formatted capital if the input has leading or trailing spaces
const retrieveStateNameByCapital = //returns "Ohio" //returns null //returns null