/** * @copyright Sister Software. * @license AGPL-3.0 * @author Teffen Ellis, et al. */ import type { GeoFeature, MultiPolygonLiteral } from "@mailwoman/spatial"; import type { GeoIDPart } from "./geoid.ts"; import type { TIGERTabulatedBlockProperties } from "./tabulation-block.ts"; /** * FIPS codes for US States. * * @category FIPS * @category States * @category Census * @see {@linkcode FIPSTerritoryCode} for territories. * @see {@linkcode AdminLevel1Code} for a combined set of states and territories. */ export declare const FIPSStateCode: { /** * @title Alabama */ readonly AL: "01"; /** * @title Alaska */ readonly AK: "02"; /** * @title Arizona */ readonly AZ: "04"; /** * @title Arkansas */ readonly AR: "05"; /** * @title California */ readonly CA: "06"; /** * @title Colorado */ readonly CO: "08"; /** * @title Connecticut */ readonly CT: "09"; /** * @title Delaware */ readonly DE: "10"; /** * @title District Of Columbia */ readonly DC: "11"; /** * @title Florida */ readonly FL: "12"; /** * @title Georgia */ readonly GA: "13"; /** * @title Hawaii */ readonly HI: "15"; /** * @title Idaho */ readonly ID: "16"; /** * @title Illinois */ readonly IL: "17"; /** * @title Indiana */ readonly IN: "18"; /** * @title Iowa */ readonly IA: "19"; /** * @title Kansas */ readonly KS: "20"; /** * @title Kentucky */ readonly KY: "21"; /** * @title Louisiana */ readonly LA: "22"; /** * @title Maine */ readonly ME: "23"; /** * @title Maryland */ readonly MD: "24"; /** * @title Massachusetts */ readonly MA: "25"; /** * @title Michigan */ readonly MI: "26"; /** * @title Minnesota */ readonly MN: "27"; /** * @title Mississippi */ readonly MS: "28"; /** * @title Missouri */ readonly MO: "29"; /** * @title Montana */ readonly MT: "30"; /** * @title Nebraska */ readonly NE: "31"; /** * @title Nevada */ readonly NV: "32"; /** * @title New Hampshire */ readonly NH: "33"; /** * @title New Jersey */ readonly NJ: "34"; /** * @title New Mexico */ readonly NM: "35"; /** * @title New York */ readonly NY: "36"; /** * @title North Carolina */ readonly NC: "37"; /** * @title North Dakota */ readonly ND: "38"; /** * @title Ohio */ readonly OH: "39"; /** * @title Oklahoma */ readonly OK: "40"; /** * @title Oregon */ readonly OR: "41"; /** * @title Pennsylvania */ readonly PA: "42"; /** * @title Rhode Island */ readonly RI: "44"; /** * @title South Carolina */ readonly SC: "45"; /** * @title South Dakota */ readonly SD: "46"; /** * @title Tennessee */ readonly TN: "47"; /** * @title Texas */ readonly TX: "48"; /** * @title Utah */ readonly UT: "49"; /** * @title Vermont */ readonly VT: "50"; /** * @title Virginia */ readonly VA: "51"; /** * @title Washington */ readonly WA: "53"; /** * @title West Virginia */ readonly WV: "54"; /** * @title Wisconsin */ readonly WI: "55"; /** * @title Wyoming */ readonly WY: "56"; }; export type FIPSStateCode = (typeof FIPSStateCode)[keyof typeof FIPSStateCode]; /** * FIPS codes for US Territories. * * @category FIPS * @category Territories * @category Census * @minLength 2 * @maxLength 2 * @see {@linkcode FIPSStateCode} for states. * @see {@linkcode AdminLevel1Code} for a combined set of states and territories. */ export declare const FIPSTerritoryCode: { /** * @title Johnston Atoll */ readonly JA: "74"; /** * @title American Samoa */ readonly AS: "60"; /** * @title Guam */ readonly GU: "66"; /** * @title Northern Mariana Islands */ readonly MP: "69"; /** * @title Puerto Rico */ readonly PR: "72"; /** * @title Virgin Islands */ readonly VI: "78"; }; export type FIPSTerritoryCode = (typeof FIPSTerritoryCode)[keyof typeof FIPSTerritoryCode]; /** * A combined set of FIPS codes for US States and Territories. * * @category FIPS * @category States * @category Territories * @category Census * @minLength 2 * @maxLength 2 * @public * @see {@linkcode FIPSStateCode} for states. * @see {@linkcode FIPSTerritoryCode} for territories. */ export declare const AdminLevel1Code: { /** * @title Johnston Atoll */ readonly JA: "74"; /** * @title American Samoa */ readonly AS: "60"; /** * @title Guam */ readonly GU: "66"; /** * @title Northern Mariana Islands */ readonly MP: "69"; /** * @title Puerto Rico */ readonly PR: "72"; /** * @title Virgin Islands */ readonly VI: "78"; /** * @title Alabama */ readonly AL: "01"; /** * @title Alaska */ readonly AK: "02"; /** * @title Arizona */ readonly AZ: "04"; /** * @title Arkansas */ readonly AR: "05"; /** * @title California */ readonly CA: "06"; /** * @title Colorado */ readonly CO: "08"; /** * @title Connecticut */ readonly CT: "09"; /** * @title Delaware */ readonly DE: "10"; /** * @title District Of Columbia */ readonly DC: "11"; /** * @title Florida */ readonly FL: "12"; /** * @title Georgia */ readonly GA: "13"; /** * @title Hawaii */ readonly HI: "15"; /** * @title Idaho */ readonly ID: "16"; /** * @title Illinois */ readonly IL: "17"; /** * @title Indiana */ readonly IN: "18"; /** * @title Iowa */ readonly IA: "19"; /** * @title Kansas */ readonly KS: "20"; /** * @title Kentucky */ readonly KY: "21"; /** * @title Louisiana */ readonly LA: "22"; /** * @title Maine */ readonly ME: "23"; /** * @title Maryland */ readonly MD: "24"; /** * @title Massachusetts */ readonly MA: "25"; /** * @title Michigan */ readonly MI: "26"; /** * @title Minnesota */ readonly MN: "27"; /** * @title Mississippi */ readonly MS: "28"; /** * @title Missouri */ readonly MO: "29"; /** * @title Montana */ readonly MT: "30"; /** * @title Nebraska */ readonly NE: "31"; /** * @title Nevada */ readonly NV: "32"; /** * @title New Hampshire */ readonly NH: "33"; /** * @title New Jersey */ readonly NJ: "34"; /** * @title New Mexico */ readonly NM: "35"; /** * @title New York */ readonly NY: "36"; /** * @title North Carolina */ readonly NC: "37"; /** * @title North Dakota */ readonly ND: "38"; /** * @title Ohio */ readonly OH: "39"; /** * @title Oklahoma */ readonly OK: "40"; /** * @title Oregon */ readonly OR: "41"; /** * @title Pennsylvania */ readonly PA: "42"; /** * @title Rhode Island */ readonly RI: "44"; /** * @title South Carolina */ readonly SC: "45"; /** * @title South Dakota */ readonly SD: "46"; /** * @title Tennessee */ readonly TN: "47"; /** * @title Texas */ readonly TX: "48"; /** * @title Utah */ readonly UT: "49"; /** * @title Vermont */ readonly VT: "50"; /** * @title Virginia */ readonly VA: "51"; /** * @title Washington */ readonly WA: "53"; /** * @title West Virginia */ readonly WV: "54"; /** * @title Wisconsin */ readonly WI: "55"; /** * @title Wyoming */ readonly WY: "56"; }; export type AdminLevel1Code = FIPSStateCode | FIPSTerritoryCode; /** * A combined set of FIPS codes for US States and Territories. * * Maps FIPS codes to their respective two-letter abbreviations. */ export declare const AdminLevel1CodeToAbbreviation: Record; /** * Type-predicate to determine if a given string is a valid state FIPS code. */ export declare function isStateFIPSCode(code: string | null | undefined): code is FIPSStateCode; /** * Type-predicate to determine if a given string is a valid territory FIPS code. */ export declare function isTerritoryFIPSCode(code: string | null | undefined): code is FIPSTerritoryCode; /** * Type-predicate to determine if a given string is a valid state-level FIPS code. * * This includes both states and territories. */ export declare function isAdminLevel1FIPSCode(code: string | null | undefined): code is AdminLevel1Code; /** * Two-letter abbreviations of a US states. * * @minLength 2 * @maxLength 2 * @public */ export declare const StateAbbreviation: { readonly Alaska: "AK"; readonly Alabama: "AL"; readonly Arkansas: "AR"; readonly Arizona: "AZ"; readonly California: "CA"; readonly Colorado: "CO"; readonly Connecticut: "CT"; readonly "District of Columbia": "DC"; readonly Delaware: "DE"; readonly Florida: "FL"; readonly Georgia: "GA"; readonly Hawaii: "HI"; readonly Iowa: "IA"; readonly Idaho: "ID"; readonly Illinois: "IL"; readonly Indiana: "IN"; readonly Kansas: "KS"; readonly Kentucky: "KY"; readonly Louisiana: "LA"; readonly Massachusetts: "MA"; readonly Maryland: "MD"; readonly Maine: "ME"; readonly Michigan: "MI"; readonly Minnesota: "MN"; readonly Missouri: "MO"; readonly Mississippi: "MS"; readonly Montana: "MT"; readonly "North Carolina": "NC"; readonly "North Dakota": "ND"; readonly Nebraska: "NE"; readonly "New Hampshire": "NH"; readonly "New Jersey": "NJ"; readonly "New Mexico": "NM"; readonly Nevada: "NV"; readonly "New York": "NY"; readonly Ohio: "OH"; readonly Oklahoma: "OK"; readonly Oregon: "OR"; readonly Pennsylvania: "PA"; readonly "Rhode Island": "RI"; readonly "South Carolina": "SC"; readonly "South Dakota": "SD"; readonly Tennessee: "TN"; readonly Texas: "TX"; readonly Utah: "UT"; readonly Virginia: "VA"; readonly Vermont: "VT"; readonly Washington: "WA"; readonly Wisconsin: "WI"; readonly "West Virginia": "WV"; readonly Wyoming: "WY"; }; export type StateAbbreviation = (typeof StateAbbreviation)[keyof typeof StateAbbreviation]; /** * Postal abbreviations for US territories, kept apart from the states so callers can include or exclude them. */ export declare const TerritoryAbbreviation: { readonly "American Samoa": "AS"; readonly "Johnston Atoll": "JA"; readonly Guam: "GU"; readonly "Virgin Islands": "VI"; readonly "Northern Mariana Islands": "MP"; readonly "Puerto Rico": "PR"; }; export type TerritoryAbbreviation = (typeof TerritoryAbbreviation)[keyof typeof TerritoryAbbreviation]; /** * Two-letter abbreviations of a US states and territories. * * @minLength 2 * @maxLength 2 * @public */ export type AdminLevel1Abbreviation = StateAbbreviation | TerritoryAbbreviation; /** * Every admin-level-1 postal abbreviation — the fifty states, DC, and the territories together. */ export declare const AdminLevel1Abbreviation: { readonly "American Samoa": "AS"; readonly "Johnston Atoll": "JA"; readonly Guam: "GU"; readonly "Virgin Islands": "VI"; readonly "Northern Mariana Islands": "MP"; readonly "Puerto Rico": "PR"; readonly Alaska: "AK"; readonly Alabama: "AL"; readonly Arkansas: "AR"; readonly Arizona: "AZ"; readonly California: "CA"; readonly Colorado: "CO"; readonly Connecticut: "CT"; readonly "District of Columbia": "DC"; readonly Delaware: "DE"; readonly Florida: "FL"; readonly Georgia: "GA"; readonly Hawaii: "HI"; readonly Iowa: "IA"; readonly Idaho: "ID"; readonly Illinois: "IL"; readonly Indiana: "IN"; readonly Kansas: "KS"; readonly Kentucky: "KY"; readonly Louisiana: "LA"; readonly Massachusetts: "MA"; readonly Maryland: "MD"; readonly Maine: "ME"; readonly Michigan: "MI"; readonly Minnesota: "MN"; readonly Missouri: "MO"; readonly Mississippi: "MS"; readonly Montana: "MT"; readonly "North Carolina": "NC"; readonly "North Dakota": "ND"; readonly Nebraska: "NE"; readonly "New Hampshire": "NH"; readonly "New Jersey": "NJ"; readonly "New Mexico": "NM"; readonly Nevada: "NV"; readonly "New York": "NY"; readonly Ohio: "OH"; readonly Oklahoma: "OK"; readonly Oregon: "OR"; readonly Pennsylvania: "PA"; readonly "Rhode Island": "RI"; readonly "South Carolina": "SC"; readonly "South Dakota": "SD"; readonly Tennessee: "TN"; readonly Texas: "TX"; readonly Utah: "UT"; readonly Virginia: "VA"; readonly Vermont: "VT"; readonly Washington: "WA"; readonly Wisconsin: "WI"; readonly "West Virginia": "WV"; readonly Wyoming: "WY"; }; /** * US State abbreviations to their full names. * * @public */ export declare const StateName: { readonly AS: "American Samoa"; readonly AK: "Alaska"; readonly AL: "Alabama"; readonly AR: "Arkansas"; readonly AZ: "Arizona"; readonly CA: "California"; readonly CO: "Colorado"; readonly CT: "Connecticut"; readonly DC: "District of Columbia"; readonly DE: "Delaware"; readonly FL: "Florida"; readonly GA: "Georgia"; readonly HI: "Hawaii"; readonly IA: "Iowa"; readonly ID: "Idaho"; readonly IL: "Illinois"; readonly IN: "Indiana"; readonly JA: "Johnston Atoll"; readonly KS: "Kansas"; readonly KY: "Kentucky"; readonly LA: "Louisiana"; readonly MA: "Massachusetts"; readonly MD: "Maryland"; readonly ME: "Maine"; readonly MI: "Michigan"; readonly MN: "Minnesota"; readonly MO: "Missouri"; readonly MS: "Mississippi"; readonly MT: "Montana"; readonly NC: "North Carolina"; readonly ND: "North Dakota"; readonly NE: "Nebraska"; readonly NH: "New Hampshire"; readonly NJ: "New Jersey"; readonly NM: "New Mexico"; readonly NV: "Nevada"; readonly NY: "New York"; readonly OH: "Ohio"; readonly OK: "Oklahoma"; readonly OR: "Oregon"; readonly PA: "Pennsylvania"; readonly PR: "Puerto Rico"; readonly RI: "Rhode Island"; readonly SC: "South Carolina"; readonly SD: "South Dakota"; readonly TN: "Tennessee"; readonly TX: "Texas"; readonly UT: "Utah"; readonly VA: "Virginia"; readonly VT: "Vermont"; readonly WA: "Washington"; readonly WI: "Wisconsin"; readonly WV: "West Virginia"; readonly WY: "Wyoming"; readonly VI: "Virgin Islands"; readonly MP: "Northern Mariana Islands"; readonly GU: "Guam"; }; export type StateName = (typeof StateName)[keyof typeof StateName]; /** * Predicate for checking if a string is a proper abbreviation for a US State or territory, rather than a random * 2-letter string. * * @see {@link isStateAbbreviation} for a specific check for US States. * @see {@link isStateTerritoryAbbreviation} for a specific check for US Territories. */ export declare function isStateLevelAbbreviation(input: unknown): input is AdminLevel1Abbreviation; /** * Predicate for checking if a string is a proper abbreviation for a US State, rather than a random 2-letter string. * * @see {@link isStateLevelAbbreviation} for a general check for US States and Territories. * @see {@link isStateTerritoryAbbreviation} for a specific check for US Territories. */ export declare function isStateAbbreviation(input: unknown): input is StateAbbreviation; /** * Predicate for checking if a string is a proper abbreviation for a US Territory, rather than a random 2-letter string. * * @see {@link isStateLevelAbbreviation} for a general check for US States and Territories. * @see {@link isStateAbbreviation} for a specific check for US States. */ export declare function isStateTerritoryAbbreviation(input: unknown): input is AdminLevel1Abbreviation; /** * Common case variations of a US State or Territory name. * * @internal */ export type StateNameVariation = StateName | Lowercase | Uppercase; /** * Details about a US State or Territory. * * @title US State Details */ export interface StateDetails { /** * Two-letter abbreviation of the state or territory. * * @title Abbreviation */ abbreviation: AdminLevel1Abbreviation; /** * Full name of the state or territory. * * @title Name */ displayName: StateName; /** * The FIPS code for the state or territory. * * @title FIPS Code */ FIPSCode: string; /** * The ANSI code for the state or territory. * * @title ANSI Code */ ANSICode: string; } /** * A US state as defined by the Census Bureau's TIGER system. * * @title Census TIGER State * @public */ export interface TIGERState { /** * The two-letter abbreviation of a US state. * * @title State Abbreviation */ abbreviation: AdminLevel1Abbreviation; /** * The state's name. * * @title State Name */ displayName: StateName; /** * The state's FIPS code. * * @title State FIPS Code */ [GeoIDPart.State]: AdminLevel1Code; /** * The geometry of the tabulated block, typically a polygon, but may be a multi-polygon for blocks with holes, or * islands. * * @title Geometry */ GEOM: MultiPolygonLiteral; } export type TIGERStateFeature = GeoFeature; //# sourceMappingURL=state.d.ts.map