lance-ts / BatchAddressGeocoder

Class: BatchAddressGeocoder

Batch Address geocoding service.

Accepts a .csv file of addresses, formatted in the following manner:

UNIQUE ID, STREET ADDR., CITY, STATE, ZIP

Example:

TACO HEAVEN, 1234 SUNSET BLVD., CA, 12345

The output file has a slightly different format:

UNIQUE ID , ORIGINAL ADDRESS , MATCH STATUS , MATCH TYPE , COORDINATES , TIGER/Line ID , SIDE OF STREET

Unique Id: The original id passed in the inputFilePath file

Original Address: The complete address passed in the inputFilePath file

Match status: Exact (perfect match) | Tie (multiple potential locations) | Non-Exact (uncertain)

Coordinates: Longitude, Latitude

TIGER/Line ID: UID of the street segment or geographic block where the address is located

Side of Street: L (left) | R (right)

Initialization example:

const geocoder = new BatchAddressGeocoder(".../bar/addressFile.csv", ".../foo/outputFile.csv")

Constructors

Constructor

new BatchAddressGeocoder(inputFilePath, outputFilePath?): BatchAddressGeocoder

Defined in: batch-address.ts:48

Sets input and output file paths.

Parameters

inputFilePath

string

The absolute path to the input file.

outputFilePath?

string

The absolute path to the output file.

Returns

BatchAddressGeocoder

Throws

Error - "Cannot resolve file paths" if missing inputFilePath or outputFilePath

Properties

inputFilePath

inputFilePath: string

Defined in: batch-address.ts:39

outputFilePath

outputFilePath: string

Defined in: batch-address.ts:40

url

url: string = "https://geocoding.geo.census.gov/geocoder/locations/addressbatch"

Defined in: batch-address.ts:38

Methods

_createFormData()

_createFormData(filePath): FormData | undefined

Defined in: batch-address.ts:79

Generates FormData from a file, according to census geocoder specs

Parameters

filePath

string

Returns

FormData | undefined

Formatted form data, converting the file into a {Blob}

_parseFilePath()

_parseFilePath(filePath): string | undefined

Defined in: batch-address.ts:62

Determines if it is passed a Finds absolute path for a new local file. Otherwise, path for existing file.

Parameters

filePath

string

Returns

string | undefined

the relative file path if it i

geocodeBatch()

geocodeBatch(): Promise\<void>

Defined in: batch-address.ts:98

Sends generated FormData from blob-ified inputFilePath to Census Geocoder endpoint, and writes response to a local file based on outputFilePath.

Returns

Promise\<void>