mindee/src/parsing/standard/addressField.d.ts

Mindee Client Library for Node.js

import { StringField, FieldConstructor } from "./text";
/**
 * A field containing a detailed address value broken down into components
 * (street number, city, postal code, …) while still exposing the full
 * address string through {@link StringField.value}.
 */
export declare class AddressField extends StringField {
    /** Street number. */
    streetNumber?: string;
    /** Street name. */
    streetName?: string;
    /** PO-box number. */
    poBox?: string;
    /** Additional address complement. */
    addressComplement?: string;
    /** City or locality. */
    city?: string;
    /** Postal / ZIP code. */
    postalCode?: string;
    /** State, province or region. */
    state?: string;
    /** Country. */
    country?: string;
    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
}