@types/zipcodes

Installation

npm install --save @types/zipcodes

Summary

This package contains type definitions for zipcodes (https://github.com/davglass/zipcodes#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/zipcodes.

index.d.ts

export as namespace ZipCodes;

export interface ZipCode {
    zip: string;
    latitude: number;
    longitude: number;
    city: string;
    state: string;
    country: string;
}

export const codes: Record<string, ZipCode>;

export const states: {
    full: Record<string, string>;
    abbr: Record<string, string>;
    normalize: (state: string) => string;
};
export function lookup(zip: string | number): ZipCode | undefined;

export function lookupByName(city: string, state: string): ZipCode[];

export function lookupByState(state: string): ZipCode[];

export function distance(zipA: string | number, zipB: string | number): number | null;

export function radius(zip: string | number, miles: number, full?: boolean): string[] | ZipCode[];

export function toMiles(kilos: number): number;

export function toKilometers(miles: number): number;

export function lookupByCoords(lat: number, lon: number): ZipCode | null;

export function random(): ZipCode;

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Brayden Lopez, Dobes Vandermeer, and Piotr Błażejewicz.