@types/zipcodes NPM

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

// Type definitions for zipcodes 8.0
// Project: https://github.com/davglass/zipcodes#readme
// Definitions by: Brayden Lopez <https://github.com/headdetect>
//                 Dobes Vandermeer <https://github.com/dobesv>
//                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

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): string | null;

export function random(): ZipCode;