/** * @copyright Sister Software. * @license AGPL-3.0 * @author Teffen Ellis, et al. */ import type { TIGERClassCode } from "./class-code.ts"; import type { TIGERFunctionalStatus } from "./functional-status.ts"; import type { GeoIDPart, FIPSBlockCode, FIPSBlockGroupCode, FIPSCongressionalDistrictCode, FIPSCountyCode, FIPSCountySubDivisionCode, FIPSPlaceCode, FIPSTractCode } from "./geoid.ts"; import type { LegalStatisticalAreaDescription } from "./legal-statistical-area.ts"; import type { FIPSStateCode } from "./state.ts"; /** * A code indicating the classification of the block, i.e. urban or rural. * * @title TIGER Geographic Classification * * @minLength 1 * @maxLength 1 */ export declare const TIGERGeographicClassification: { readonly Urban: "U"; readonly Rural: "R"; }; export type TIGERGeographicClassification = (typeof TIGERGeographicClassification)[keyof typeof TIGERGeographicClassification]; /** * @title Land/Water Block Type * * A code indicating the type of feature represented by the land/water block. */ export declare const LandWaterBlockType: { /** * Block is land. */ readonly Land: "L"; /** * Block is water. */ readonly Water: "W"; }; export type LandWaterBlockType = (typeof LandWaterBlockType)[keyof typeof LandWaterBlockType]; /** * @title TIGER Property */ export declare const TIGERProperty: { /** * @title Geographic Identifier */ readonly GeoID: "GEOID"; /** * @title Display Name */ readonly DisplayName: "display_name"; /** * @title Urban/Rural Code */ readonly UrbanRuralCode: "urban_rural_code"; /** * @title Urban Area Code */ readonly UrbanizedAreaCode: "urbanized_area_code"; /** * @title Land Area (square meters) */ readonly LandAreaSqm: "land_area_sqm"; /** * @title Water Area (square meters) */ readonly WaterAreaSqm: "water_area_sqm"; /** * @title Housing Unit Count */ readonly HousingUnitCount: "housing_unit_count"; /** * @title Population Count */ readonly Population: "population"; /** * @title Functional Status */ readonly FunctionalStatus: "functional_status"; /** * @title Centroid Latitude */ readonly CentroidLatitude: "latitude"; /** * @title Centroid Longitude */ readonly CentroidLongitude: "longitude"; /** * @title Legal/Statistical Area Description */ readonly LegalStatisticalAreaDescription: "legal_statistical_area_description"; /** * @title MAF/TIGER Feature Class Code */ readonly ClassCode: "class_code"; }; export type TIGERProperty = (typeof TIGERProperty)[keyof typeof TIGERProperty]; /** * Properties common to all Census. */ export interface TIGERPropertyRecord { /** * @title Geographic Identifier */ [TIGERProperty.GeoID]: GeoID; /** * @title State FIPS Code. */ [GeoIDPart.State]: FIPSStateCode; /** * @title County */ [GeoIDPart.County]: FIPSCountyCode; /** * @title County Sub Division */ [GeoIDPart.CountySubDivision]: FIPSCountySubDivisionCode; /** * @title Tract */ [GeoIDPart.Tract]: FIPSTractCode; /** * @title Place */ [GeoIDPart.Place]: FIPSPlaceCode; /** * @title Congressional District */ [GeoIDPart.CongressionalDistrict]: FIPSCongressionalDistrictCode; /** * @title Block */ [GeoIDPart.Block]: FIPSBlockCode; /** * @title Block Group */ [GeoIDPart.BlockGroup]: FIPSBlockGroupCode; /** * Urban/Rural Code. * * @title Urban/Rural Code * * @minLength 1 * @maxLength 1 */ [TIGERProperty.UrbanRuralCode]: TIGERGeographicClassification; /** * A code indicating a specific urban area, such as a specific city, or a specific region of cities. * * For example, 23824 references Detroit, MI. 63217 references the region of New York City, Jersey City, and Newark. * * @title Urban Area Code * @minLength 5 * @maxLength 5 */ [TIGERProperty.UrbanizedAreaCode]: string; /** * Land Area in square meters. * * @type {integer} * @title Land Area * @minimum 0 */ [TIGERProperty.LandAreaSqm]: number; /** * Water Area in square meters. * * @type {integer} * @title Water Area * @minimum 0 */ [TIGERProperty.WaterAreaSqm]: number; /** * The tabulated block's housing unit count. * * Note: This is the number of housing units in the block, not the number of people. * * @type {integer} * @title Housing Units * @minimum 0 */ [TIGERProperty.HousingUnitCount]: number; /** * The tabulated block's population count. * * @type {integer} * @title Population Count * @minimum 0 */ [TIGERProperty.Population]: number; /** * @title Legal/Statistical Area Description */ [TIGERProperty.LegalStatisticalAreaDescription]: LegalStatisticalAreaDescription; /** * @title MAF/TIGER Feature Class Code */ [TIGERProperty.ClassCode]: TIGERClassCode; /** * Functional Status. * * @title Functional Status * @minLength 1 * @maxLength 1 * @pattern ^[A-Z]$ */ [TIGERProperty.FunctionalStatus]: TIGERFunctionalStatus; /** * Longitude of the internal point. * * @title Centroid Longitude */ [TIGERProperty.CentroidLongitude]: number; /** * Latitude of the internal point. * * @title Centroid Latitude */ [TIGERProperty.CentroidLatitude]: number; } //# sourceMappingURL=constants.d.ts.map