@types/node-postal v1.1.3

Installation

npm install --save @types/node-postal

Summary

This package contains type definitions for node-postal (https://github.com/openvenues/node-postal).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-postal.

index.d.ts

// Type definitions for node-postal 1.1
// Project: https://github.com/openvenues/node-postal
// Definitions by: João Carmo <https://github.com/joaocarmo>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

// Source: https://github.com/openvenues/libpostal#parser-labels
export type PostalLabels =
    | 'category'
    | 'city_district'
    | 'city'
    | 'country_region'
    | 'country'
    | 'entrance'
    | 'house_number'
    | 'house'
    | 'island'
    | 'level'
    | 'near'
    | 'po_box'
    | 'postcode'
    | 'road'
    | 'staircase'
    | 'state_district'
    | 'state'
    | 'suburb'
    | 'unit'
    | 'world_region';

export interface PostalResult {
    component: PostalLabels;
    value: string;
}

declare function expand_address(address: string): string[];

declare function parse_address(address: string): PostalResult[];

export const expand: {
    expand_address: typeof expand_address;
};

export const parser: {
    parse_address: typeof parse_address;
};

export { };

Additional Details

• Last updated: Wed, 06 Apr 2022 18:31:45 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by João Carmo.