@mailwoman/tiger 4.16.2 → 5.1.0

package/constants.ts

@@ -166,11 +166,9 @@ export interface TIGERPropertyRecord<GeoID extends string = string> {
 	[TIGERProperty.UrbanRuralCode]: TIGERGeographicClassification
 
 	/**
-	 * A code indicating a specific urban area, such as a specific city, or a specific region of
-	 * cities.
+	 * 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.
+	 * For example, 23824 references Detroit, MI. 63217 references the region of New York City, Jersey City, and Newark.
 	 *
 	 * @title Urban Area Code
 	 * @minLength 5

package/county-subdivision.ts

@@ -39,22 +39,22 @@ export interface TIGERCountySubdivision {
 	COUSUBFP: string
 
 	/**
-	 * @see {@link https://www.usgs.gov/us-board-on-geographic-names/domestic-names | USGS: Domestic Names}
 	 * @title County Subdivision GNIS Code
 	 *
 	 * @minLength 8
 	 * @maxLength 8
 	 * @pattern ^\d{8}$
+	 * @see {@link https://www.usgs.gov/us-board-on-geographic-names/domestic-names | USGS: Domestic Names}
 	 */
 	COUSUBNS: string
 	/**
 	 * Concatenation of current state FIPS code, county FIPS code, and county subdivision FIPS code.
 	 *
-	 * @see {@link https://www.census.gov/programs-surveys/geography/guidance/geo-identifiers.html | Census: GeoID}
 	 * @title County Sub-division Identifier
 	 * @minLength 10
 	 * @maxLength 20
 	 * @pattern ^\d{10,20}$
+	 * @see {@link https://www.census.gov/programs-surveys/geography/guidance/geo-identifiers.html | Census: GeoID}
 	 */
 	GEOID: string
 
@@ -69,8 +69,7 @@ export interface TIGERCountySubdivision {
 	GEOIDFQ: string
 
 	/**
-	 * Current name and the translated legal/statistical area description code for county
-	 * sub-division.
+	 * Current name and the translated legal/statistical area description code for county sub-division.
 	 *
 	 * @title Name/Legal Statistical Area Description
 	 * @minLength 1

package/county.ts

@@ -28,12 +28,12 @@ export interface TIGERCounty {
 	COUNTYFP: string
 
 	/**
-	 * @see {@link https://www.usgs.gov/us-board-on-geographic-names/domestic-names | USGS: Domestic Names}
 	 * @title County GNIS Code
 	 *
 	 * @minLength 8
 	 * @maxLength 8
 	 * @pattern ^\d{8}$
+	 * @see {@link https://www.usgs.gov/us-board-on-geographic-names/domestic-names | USGS: Domestic Names}
 	 */
 	GEOID: string
 
@@ -48,8 +48,7 @@ export interface TIGERCounty {
 	GEOIDFQ: string
 
 	/**
-	 * Current name and the translated legal/statistical area description code for county
-	 * sub-division.
+	 * Current name and the translated legal/statistical area description code for county sub-division.
 	 *
 	 * @title Name/Legal Statistical Area Description
 	 * @minLength 1

package/files.ts

@@ -156,6 +156,7 @@ export function TIGERNationZIPPath<Vintage extends number = TIGERCurrentVintage>
 	const fileName = `tl_${vintage}_${TIGERLevel.State}${TIGERFileExtension.Zip}` as const
 
 	const path = `/geo/tiger/TIGER${vintage}/STATE/${fileName}` as const
+
 	// https://www2.census.gov/geo/tiger/TIGER2023/STATE/tl_2023_us_state.zip
 
 	return path

package/functional-status.ts

@@ -11,13 +11,12 @@
  */
 export enum TIGERFunctionalStatus {
 	/**
-	 * Active government providing primary general-purpose functions. Active entity (federally
-	 * recognized entities only).
+	 * Active government providing primary general-purpose functions. Active entity (federally recognized entities only).
 	 */
 	ActiveGovernment = "A",
 	/**
-	 * Active government that is partially consolidated with another government but with separate
-	 * officials providing primary general-purpose functions.
+	 * Active government that is partially consolidated with another government but with separate officials providing
+	 * primary general-purpose functions.
 	 */
 	PartiallyConsolidatedActiveGovernment = "B",
 	/**
@@ -41,8 +40,7 @@ export enum TIGERFunctionalStatus {
 	 */
 	InActiveGovernmentalUnit = "I",
 	/**
-	 * Inactive, nonfunctioning legal real property entity with potential quasi-legal administrative
-	 * functions.
+	 * Inactive, nonfunctioning legal real property entity with potential quasi-legal administrative functions.
 	 */
 	InactiveNonFunctioningLegalRealPropertyEntity = "L",
 	/**

package/geoid.ts

@@ -5,6 +5,7 @@
  */
 
 import type { Tagged } from "type-fest"
+
 import { AdminLevel1Code, FIPSStateCode } from "./state.js"
 
 //#region Tagged FIPS types
@@ -22,12 +23,12 @@ import { AdminLevel1Code, FIPSStateCode } from "./state.js"
  * @category Census
  * @category FIPS
  * @type {string}
- * @see {@linkcode FIPSBlockGroupCode} for a less specific level.
- * @see {@linkcode FIPSBlockGeoID} for the full GeoID.
  * @pattern ^\d{4}$
  * @minLength 4
  * @maxLength 4
  * @title FIPS Block Code
+ * @see {@linkcode FIPSBlockGroupCode} for a less specific level.
+ * @see {@linkcode FIPSBlockGeoID} for the full GeoID.
  */
 export type FIPSBlockCode = Tagged<string, "FIPSBlockCode">
 
@@ -44,11 +45,11 @@ export type FIPSBlockCode = Tagged<string, "FIPSBlockCode">
  * @category Census
  * @category FIPS
  * @type {string}
- * @see {@linkcode FIPSBlockCode} for the 4-digit version.
  * @pattern ^\d{15}$
  * @minLength 15
  * @maxLength 15
  * @title FIPS Block Geo ID
+ * @see {@linkcode FIPSBlockCode} for the 4-digit version.
  */
 export type FIPSBlockGeoID = Tagged<string, "FIPSBlockGeoID">
 
@@ -65,12 +66,12 @@ export type FIPSBlockGeoID = Tagged<string, "FIPSBlockGeoID">
  * @category Census
  * @category FIPS
  * @type {string}
- * @see {@linkcode FIPSBlockCode} for a more specific level.
- * @see {@linkcode FIPSTractCode} for a less specific level.
  * @pattern ^\d{1}$
  * @minLength 1
  * @maxLength 1
  * @title FIPS Block Group Code
+ * @see {@linkcode FIPSBlockCode} for a more specific level.
+ * @see {@linkcode FIPSTractCode} for a less specific level.
  */
 export type FIPSBlockGroupCode = Tagged<string, "FIPSBlockGroupCode">
 
@@ -87,12 +88,12 @@ export type FIPSBlockGroupCode = Tagged<string, "FIPSBlockGroupCode">
  * @category Census
  * @category FIPS
  * @type {string}
- * @see {@linkcode FIPSBlockGroupCode} for a more specific level.
- * @see {@linkcode FIPSCountySubDivisionCode} for a less specific level.
  * @pattern ^\d{6}$
  * @minLength 6
  * @maxLength 6
  * @title FIPS Tract Code
+ * @see {@linkcode FIPSBlockGroupCode} for a more specific level.
+ * @see {@linkcode FIPSCountySubDivisionCode} for a less specific level.
  */
 export type FIPSTractCode = Tagged<string, "FIPSTractCode">
 
@@ -109,11 +110,11 @@ export type FIPSTractCode = Tagged<string, "FIPSTractCode">
  * @category Census
  * @category FIPS
  * @type {string}
- * @see {@linkcode FIPSBlockCode} for the 4-digit version.
  * @pattern ^\d{6}$
  * @minLength 6
  * @maxLength 6
  * @title FIPS Tract Geo ID
+ * @see {@linkcode FIPSBlockCode} for the 4-digit version.
  */
 export type FIPSTractGeoID = Tagged<string, "FIPSTractGeoID">
 
@@ -130,12 +131,12 @@ export type FIPSTractGeoID = Tagged<string, "FIPSTractGeoID">
  * @category Census
  * @category FIPS
  * @type {string}
- * @see {@linkcode FIPSTractCode} for a more specific level.
- * @see {@linkcode FIPSCountyCode} for a less specific level.
  * @pattern ^\d{5}$
  * @minLength 5
  * @maxLength 5
  * @title FIPS County Sub-Division Code
+ * @see {@linkcode FIPSTractCode} for a more specific level.
+ * @see {@linkcode FIPSCountyCode} for a less specific level.
  */
 export type FIPSCountySubDivisionCode = Tagged<string, "FIPSCountySubDivisionCode">
 
@@ -151,12 +152,12 @@ export type FIPSCountySubDivisionCode = Tagged<string, "FIPSCountySubDivisionCod
  * @category Census
  * @category FIPS
  * @type {string}
- * @see {@linkcode FIPSCountySubDivisionCode} for a more specific level.
- * @see {@linkcode AdminLevel1Code} for a less specific level.
  * @pattern ^\d{3}$
  * @minLength 3
  * @maxLength 3
  * @title FIPS County Code
+ * @see {@linkcode FIPSCountySubDivisionCode} for a more specific level.
+ * @see {@linkcode AdminLevel1Code} for a less specific level.
  */
 export type FIPSCountyCode = Tagged<string, "FIPSCountyCode">
 
@@ -191,12 +192,12 @@ export type FIPSPlaceCode = Tagged<string, "FIPSPlaceCode">
  * @category Census
  * @category FIPS
  * @type {string}
- * @see {@linkcode AdminLevel1Code} for a less specific level.
- * @see {@linkcode FIPSPlaceCode} for a more specific level.
  * @pattern ^\d{2}$
  * @minLength 2
  * @maxLength 2
  * @title FIPS Congressional District Code
+ * @see {@linkcode AdminLevel1Code} for a less specific level.
+ * @see {@linkcode FIPSPlaceCode} for a more specific level.
  */
 export type FIPSCongressionalDistrictCode = Tagged<string, "FIPSConressionalDistrictCode">
 
@@ -449,8 +450,8 @@ export class GeoIDInputMatcher<T extends GeoIDPart[] = GeoIDPart[]> {
 /**
  * Record of GeoID input matchers, i.e. a pattern and parser for each grouping of GeoID components.
  *
- * @see {@linkcode GeoIDComponentMatchers} for the component-level matchers.
  * @internal
+ * @see {@linkcode GeoIDComponentMatchers} for the component-level matchers.
  */
 export const GeoIDInputMatchers = {
 	[GeoIDPart.Block]: new GeoIDInputMatcher(
@@ -502,8 +503,8 @@ export const GeoIDInputMatchers = {
 /**
  * A record of GeoID component matchers, i.e. a pattern and parser for each GeoID component.
  *
- * @see {@linkcode GeoIDInputMatchers} for the input-level matchers.
  * @internal
+ * @see {@linkcode GeoIDInputMatchers} for the input-level matchers.
  */
 const GeoIDComponentMatchers = Object.fromEntries(
 	Object.values(GeoIDPart).map((value) => {
@@ -516,6 +517,7 @@ const GeoIDComponentMatchers = Object.fromEntries(
  */
 export function isGeoIDComponent<T extends GeoIDPart>(component: T, input: unknown): input is GeoIDPartMapping[T] {
 	if (!input) return false
+
 	if (typeof input !== "string") return false
 
 	const matcher = GeoIDComponentMatchers[component]
@@ -528,8 +530,7 @@ export function isGeoIDComponent<T extends GeoIDPart>(component: T, input: unkno
 //#region GeoID Parsing
 
 /**
- * GeoID input matchers sorted by length in descending order, such that the most specific matchers
- * are first.
+ * GeoID input matchers sorted by length in descending order, such that the most specific matchers are first.
  */
 const OrderedGeoIDInputMatchers = Object.values(GeoIDInputMatchers).sort((a, b) => b.length - a.length)
 
@@ -591,6 +592,7 @@ export function parseGeoID(input: unknown): ParsedGeoID | null {
 	if (!input) return null
 
 	if (typeof input === "number") input = input.toString()
+
 	if (typeof input !== "string") return null
 
 	if (input.length === GeoIDInputMatchers[GeoIDPart.Block].length) {

package/legal-statistical-area.ts

@@ -7,11 +7,10 @@
 /**
  * Describes the particular typology for each geographic entity.
  *
- * For legal entities, the LSAD reflects the term that appears in legal documentation pertaining to
- * the entity, such as a treaty, charter, legislation, resolution, or ordinance.
+ * For legal entities, the LSAD reflects the term that appears in legal documentation pertaining to the entity, such as
+ * a treaty, charter, legislation, resolution, or ordinance.
  *
- * For statistical entities, the LSAD is the term assigned by the Census Bureau or other agency
- * defining the entity.
+ * For statistical entities, the LSAD is the term assigned by the Census Bureau or other agency defining the entity.
  *
  * @title Legal/Statistical Area Description
  */
@@ -96,8 +95,7 @@ export enum LegalStatisticalAreaDescription {
 	 */
 	CensusSubDistrict = "24",
 	/**
-	 * Consolidated City, County or Equivalent Feature, County Subdivision, Economic Census Place,
-	 * Incorporated Place.
+	 * Consolidated City, County or Equivalent Feature, County Subdivision, Economic Census Place, Incorporated Place.
 	 */
 	City = "25",
 	CountySuffixCountySubdivision = "26",

package/out/block-group.d.ts

@@ -32,12 +32,12 @@ export interface TIGERBlockGroup {
      */
     COUSUBFP: string;
     /**
-     * @see {@link https://www.usgs.gov/us-board-on-geographic-names/domestic-names | USGS: Domestic Names}
      * @title County Subdivision GNIS Code
      *
      * @minLength 8
      * @maxLength 8
      * @pattern ^\d{8}$
+     * @see {@link https://www.usgs.gov/us-board-on-geographic-names/domestic-names | USGS: Domestic Names}
      */
     COUSUBNS: string;
     /**
@@ -58,8 +58,7 @@ export interface TIGERBlockGroup {
      */
     GEOIDFQ: string;
     /**
-     * Current name and the translated legal/statistical area description code for county
-     * sub-division.
+     * Current name and the translated legal/statistical area description code for county sub-division.
      *
      * @title Name/Legal Statistical Area Description
      * @minLength 1

package/out/block-group.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"block-group.d.ts","sourceRoot":"","sources":["../block-group.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AACnE,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,6BAA6B,CAAA;AAClF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,OAAO,EAAE,eAAe,CAAA;IAExB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;;OAOG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;;;;;OAOG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,IAAI,EAAE,+BAA+B,CAAA;IAErC;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAA;IAEvB;;;;;;;;OAQG;IACH,KAAK,EAAE,cAAc,CAAA;IAErB;;;;;;;OAOG;IACH,QAAQ,EAAE,qBAAqB,CAAA;IAE/B;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAA;CACZ"}
+{"version":3,"file":"block-group.d.ts","sourceRoot":"","sources":["../block-group.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AACnE,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,6BAA6B,CAAA;AAClF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,OAAO,EAAE,eAAe,CAAA;IAExB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;;OAOG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,IAAI,EAAE,+BAA+B,CAAA;IAErC;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAA;IAEvB;;;;;;;;OAQG;IACH,KAAK,EAAE,cAAc,CAAA;IAErB;;;;;;;OAOG;IACH,QAAQ,EAAE,qBAAqB,CAAA;IAE/B;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAA;CACZ"}