awesome-cordova-plugins/src/plugins/native-geocoder.ts

import { Plugin, Cordova } from './plugin';

/**
 * @name NativeGeocoder
 * @description
 * Cordova plugin for native forward and reverse geocoding
 *
 * @usage
 * ```typescript
 * import { NativeGeocoder, NativeGeocoderReverseResult, NativeGeocoderForwardResult } from 'ionic-native';
 *
 * NativeGeocoder.reverseGeocode(52.5072095, 13.1452818)
 *   .then((result: NativeGeocoderReverseResult) => console.log("The address is " + result.address + " in " + result.countryCode))
 *   .catch((error: any) => console.log(error));
 *
 * NativeGeocoder.forwardGeocode("Berlin")
 *   .then((coordinates: NativeGeocoderForwardResult) => console.log("The coordinates are latitude=" + coordinates.latitude + " and longitude=" + coordinates.longitude))
 *   .catch((error: any) => console.log(error));
 * ```
 * @interfaces
 * NativeGeocoderReverseResult
 * NativeGeocoderForwardResult
 */
@Plugin({
  name: 'NativeGeocoder',
  plugin: 'cordova-plugin-nativegeocoder',
  pluginRef: 'nativegeocoder',
  repo: 'https://github.com/sebastianbaar/cordova-plugin-nativegeocoder',
  platforms: ['iOS', 'Android']
})
export class NativeGeocoder {

  /**
   * Reverse geocode a given latitude and longitude to find location address
   * @param latitude {number} The latitude
   * @param longitude {number} The longitude
   * @return {Promise<any>}
   */
  @Cordova({
    callbackOrder: 'reverse'
  })
  static reverseGeocode(latitude: number, longitude: number): Promise<NativeGeocoderReverseResult> { return; }

  /**
   * Forward geocode a given address to find coordinates
   * @param addressString {string} The address to be geocoded
   * @return {Promise<any>}
   */
  @Cordova({
    callbackOrder: 'reverse'
  })
  static forwardGeocode(addressString: string): Promise<NativeGeocoderForwardResult> { return; }

}

/**
 * Encapsulates format information about a reverse geocoding result.
 */
export interface NativeGeocoderReverseResult {
  /**
   * The street.
   */
  street: string;
  /**
   * The house number.
   */
  houseNumber: string;
  /**
   * The postal code.
   */
  postalCode: string;
  /**
   * The city.
   */
  city: string;
  /**
   * The country name.
   */
  countryName: string;
  /**
   * The country code.
   */
  countryCode: string;
}
/**
 * Encapsulates format information about a forward geocoding result.
 */
export interface NativeGeocoderForwardResult {
  /**
   * The latitude.
   */
  latitude: string;
  /**
   * The longitude.
   */
  longitude: string;
}