@universe/fips
v1.0.2
Published
Universe FIPS lookup.
Keywords
Readme
County FIPS Codes
A zero dependency tool for looking up FIPS state and county codes, with full Typescript support.
Usage
import * as fips from '@universe/fips';
// Request state FIPS data by:
fips.getState('CA'); // State Code
fips.getState('California'); // State Name (Case Insensitive)
fips.getState('06'); // FIPS Code String
fips.getState(6); // FIPS Code String
// Request county FIPS data by:
fips.getCounty('MA', 'Berkshire'); // State Code and County Name
fips.getCounty('Massachusetts', '003'); // State Name and County FIPS Code String
fips.getCounty(25, 3); // State and County FIPS Code Number
fips.getCounty('25003'); // Unified County FIPS Code String
// Request all county FIPS data for a state. All search input options above supported.
fips.getState('CA');Public Interfaces
// Get State FIPS Data.
function getState(state: State | string | number): StateFipsDescriptor | null;
// Get County FIPS Data.
function getCounty(state: State | string | number, county?: string | number): CountyFipsDescriptor | null;
// Get All FIPS County Data for a State.
function getCounties(state: State | string | number): CountyFipsDescriptor[] | null;
// Describes a FIPS state.
interface StateFipsDescriptor {
readonly stateCode: State;
readonly stateName: string;
readonly stateFips: string;
}
// Describes a FIPS county or sub-state administrative boundary.
interface CountyFipsDescriptor {
readonly type: FipsType;
readonly name: string;
readonly fips: string;
readonly stateCode: State;
readonly stateName: string;
readonly stateFips: string;
readonly countyName: string;
readonly countyFips: string;
readonly class: FipsClass;
}
// The type of administrative boundary in question.
enum FipsType {
COUNTY = 'County',
PARISH = 'Parish',
BOROUGH = 'Borough',
DISTRICT = 'District',
CENSUS_AREA = 'Census Area',
MUNICIPALITY = 'Municipality',
TERRITORY = 'Territory',
ISLAND = 'Island',
CITY = 'City',
CITY_BOROUGH = 'City and Borough',
CITY_COUNTY = 'City and County'
}
/*
* FIPS Class Codes
* H1: Identifies an active county or statistically equivalent entity that does
* not qualify under subclass C7 or H6.
* H4: Identifies a legally defined inactive or nonfunctioning county
* or statistically equivalent entity that does not qualify under subclass H6.
* H5: Identifies census areas in Alaska, a statistical county equivalent entity.
* H6: identifies a county or statistically equivalent entity that is already
* coextensive or governmentally consolidated with an incorporated place,
* part of an incorporated place, or a consolidated city.
* C7: identifies an incorporated place that is an independent city; that is,
* it also serves as a county equivalent because it is not part of any county,
* and a minor civil division (MCD) equivalent because it is not part of any MCD.
*/
type FipsClass = 'H1' | 'H4' | 'H5' | 'H6' | 'C7';Source
U.S. Census Bureau (2010). Here is the CSV data for all of the United States.
All Typescript interfaces and data in src/data.ts are auto-generated from the source CSV by running node ./data/generate.js.
