@cfxlabsinc/b2b-services
    Preparing search index...

    Class MapboxGeocodingClient

    Index
    constructor
    forwardGeocode reverseGeocode

    • country (ISO 3166-1 alpha-2, comma separated) restricts the search set. Pass it whenever the caller already knows the country: a bare postcode is ambiguous worldwide, so an unrestricted search can resolve a US ZIP to a foreign postcode of the same digits and hand back the wrong country.

      Parameters

      • args: { country?: string; query: string; types?: string }

      Returns Promise<
          | {
              address: {
                  address_number: string;
                  mapbox_id: string;
                  name: string;
                  street_name: string;
              };
              country: {
                  country_code: string;
                  country_code_alpha_3: string;
                  mapbox_id: string;
                  name: string;
                  wikidata_id: string;
              };
              district: { mapbox_id: string; name: string; wikidata_id: string };
              neighborhood: { mapbox_id: string; name: string };
              place: { mapbox_id: string; name: string; wikidata_id: string };
              postcode: { mapbox_id: string; name: string };
              region: {
                  mapbox_id: string;
                  name: string;
                  region_code: string;
                  region_code_full: string;
                  wikidata_id: string;
              };
              street: { mapbox_id: string; name: string };
          }
          | undefined,
      >

    • Parameters

      • args: { lat: string; long: string }

      Returns Promise<
          | {
              address: {
                  address_number: string;
                  mapbox_id: string;
                  name: string;
                  street_name: string;
              };
              country: {
                  country_code: string;
                  country_code_alpha_3: string;
                  mapbox_id: string;
                  name: string;
                  wikidata_id: string;
              };
              district: { mapbox_id: string; name: string; wikidata_id: string };
              neighborhood: { mapbox_id: string; name: string };
              place: { mapbox_id: string; name: string; wikidata_id: string };
              postcode: { mapbox_id: string; name: string };
              region: {
                  mapbox_id: string;
                  name: string;
                  region_code: string;
                  region_code_full: string;
                  wikidata_id: string;
              };
              street: { mapbox_id: string; name: string };
          }
          | undefined,
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods