Member Junction
    Preparing search index...

    Interface IGeocodingProvider

    Common interface all geocoding providers implement. New providers are registered via GeocodingProviderRegistry.Register() — no core changes needed.

    interface IGeocodingProvider {
        AllowsPersistentStorage: boolean;
        Name: string;
        SupportedCountries: "global" | readonly string[];
        Geocode(req: GeocodeRequest): Promise<ProviderGeocodeResult>;
        IsConfigured(): boolean;
        ReverseGeocode(req: ReverseGeocodeRequest): Promise<ProviderGeocodeResult>;
    }

    Implemented by

    Index

    Properties

    AllowsPersistentStorage Name SupportedCountries

    Methods

    Geocode IsConfigured ReverseGeocode

    Properties

    AllowsPersistentStorage: boolean

    True if the provider's free tier / ToS permits indefinite persistent storage of geocoding results. Used to gate use for RecordGeoCode persistence.

    Name: string

    Stable identifier used in config and the GeocodingSource enum (e.g. 'google', 'geocodio', 'here').

    SupportedCountries: "global" | readonly string[]

    'global' if the provider supports all countries, otherwise an array of ISO 3166-1 alpha-2 codes. Used for routing decisions when a country is known up-front.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods