开始使用

安装

bun add @capgo/nativegeocoder
bunx cap sync

导入

import { NativeGeocoder } from '@capgo/nativegeocoder';

API 概述

reverseGeocode

将经纬度转换为地址

import { NativeGeocoder } from '@capgo/nativegeocoder';

await NativeGeocoder.reverseGeocode({} as ReverseOptions);

forwardGeocode

将地址转换为经纬度

import { NativeGeocoder } from '@capgo/nativegeocoder';

await NativeGeocoder.forwardGeocode({} as ForwardOptions);

类型参考

ReverseOptions

export interface ReverseOptions {
  /**
   * latitude is a number representing the latitude of the location.
   */
  latitude: number;
  /**
   * longitude is a number representing the longitude of the location.
   */
  longitude: number;
  /**
   * Localise the results to the given locale.
   */
  useLocale?: boolean;
  /**
   * locale is a string in the format of language_country, for example en_US.
   */
  defaultLocale?: string;
  /**
   * Max number of results to return.
   */
  maxResults?: number;
  /**
   * Only used for web platform to use google api
   */
  apiKey?: string;
  /**
   * Only used for web platform to use google api
   */
  resultType?: string;
}

Address

export interface Address {
  latitude: number;
  longitude: number;
  countryCode: string;
  countryName: string;
  postalCode: string;
  administrativeArea: string;
  subAdministrativeArea: string;
  locality: string;
  subLocality: string;
  thoroughfare: string;
  subThoroughfare: string;
  areasOfInterest: string[];
}

ForwardOptions

export interface ForwardOptions {
  /**
   * address is a string of the address to be geocoded.
   */
  addressString: string;
  /**
   * Localise the results to the given locale.
   */
  useLocale?: boolean;
  /**
   * locale is a string in the format of language_country, for example en_US.
   */
  defaultLocale?: string;
  /**
   * Max number of results to return.
   */
  maxResults?: number;
  /**
   * Only used for web platform to use google api
   */
  apiKey?: string;
}

真实来源

本页面由插件生成 src/definitions.ts当公共 API 上游发生变化时，请重新运行同步。