w3w node wrapper下載w3w node wrapper源代碼下載

What3words JavaScript API包裝器

一個JavaScript庫，以向What3Words REST API提出請求。現在，可以更好地支持在瀏覽器和基於節點的環境中使用！有關如何使用我們的REST API，請參見What What 3words公共API文檔。

概述

What3Words JavaScript包裝器可讓您對以下程序進行程序化訪問：

將3個單詞地址轉換為坐標
將坐標轉換為3個單詞地址
AutoSuggest功能，該功能略有不正確的3個單詞地址，並建議有效的3個單詞地址列表
獲取一個邊界框的3M x 3M What3words網格的部分。
確定當前支持3個單詞地址語言。

安裝

NPM：

npm install @what3words/api

紗：

yarn add @what3words/api

如果您希望使用內置運輸，您還需要為它們安裝同伴依賴項。有關默認運輸的更多信息，請閱讀有關運輸的部分。

用法

JavaScript

 const what3words ,
  { fetchTransport } = require ( '@what3words/api' ) ;

const apiKey = '<YOUR_API_KEY>' ;
const config = {
  host : 'https://api.what3words.com' ,
  apiVersion : 'v3' ,
} ;
const transport = fetchTransport ( ) ; // or you can import 'axiosTransport' instead
const w3wService = what3words ( apiKey , config , { transport } ) ;

// you can uncomment the following lines to set your api key and config after instantiation of the w3w service
// w3wService.setApiKey(apiKey);
// w3wService.setConfig(config);

打字稿

 import what3words , {
  ApiVersion ,
  Transport ,
  What3wordsService ,
  axiosTransport ,
} from '@what3words/api' ;

const apiKey = '<YOUR_API_KEY>' ;
const config : {
  host : string ;
  apiVersion : ApiVersion ;
} = {
  host : 'https://api.what3words.com' ,
  apiVersion : ApiVersion . Version3 ,
} ;
const transport : Transport = axiosTransport ( ) ;
const w3wService : What3wordsService = what3words ( apiKey , config , { transport } ) ;

// code continues...

文件

What3Words服務

What3wordsService提供了一種快速簡便的方法來實例化API客戶端，可用於針對Whath3words API提出請求。它還提供了用於設置API配置的助手功能，例如主機和API版本以及您的API鍵，跨Whath3Words API客戶端。

客戶

該庫中的What3words API客戶端用於驗證請求選項，序列化和處理API端點的請求/響應以及錯誤。每個客戶端擴展了抽象的ApiClient類。

每個請求都有一個特定的客戶端，您可以獨立於What3wordsService使用它們。如果您想擴展客戶行為，最大程度地減少代碼，或者在更極端的示例中，使用自定義傳輸來處理每個客戶端的請求，則這可能特別有用。

每個客戶都接受以下參數：

範圍	數據類型	預設值
Apikey	細繩	`''`
config	config.host	`https://api.what3words.com`
	config.apiversion	`v3`

運輸

運輸是負責對API執行請求的函數。鑑於ClientRequest運輸，運輸應歸還解決TransportResponse轉運的承諾。

ClientRequest由以下屬性組成：

財產	數據類型
主持人*	`string`
URL *	`string`
方法*	`get`或`post`
詢問	`object`
標題	`object`
身體	`object`
格式*	`json`或`geojson` 。默認值： `json`

TransportResponse由以下屬性組成：

財產	數據類型
地位*	`number`
statustext *	`string`
身體*	`any`
標題	`object`

您可以使用兩個內置運輸，可以使用。交叉搭或軸是。如果您想自己實例化客戶端，請指定您想在What3wordsService或客戶端初始化時使用哪種運輸。

內建

有兩種內置運輸：

交叉補充
軸

為了使用其中的任何一種，您都需要安裝同伴依賴性。默認情況下， What3wordsService或任何未提供覆蓋的固定客戶端都假定了交叉fetch。

NPM：

npm install cross-fetch

或者

npm install axios

紗：

yarn add cross-fetch

或者

yarn add axios

風俗

如果您想使用另一個庫來處理請求，則可以提供自己的自定義運輸，如果您有其他集成，或者已經在其他地方使用了HTTP庫，這可能很有用。

為了這樣做，您需要定義自己的Transport ，並將其傳遞到What3wordsService或客戶端以使用它。

您創建的自定義Transport應該是一個接受ClientRequest函數作為參數，並返回解決TransportResponse的承諾。

例子

定制運輸

 import what3words , { ClientRequest , TransportResponse } from '@what3words/api' ;
import superagent from 'superagent' ;

const API_KEY = '<YOUR_API_KEY>' ;
const config = { } ; // This will ensure we do not override the defaults

function customTransport < ResponseType > (
  request : ClientRequest
) : Promise < TransportResponse < ResponseType > > {
  const {
    method ,
    host ,
    url ,
    query = { } ,
    headers = { } ,
    body = { } ,
    format ,
  } = request ;
  return new Promise ( resolve =>
    superagent [ method ] ( ` ${ host } ${ url } ` )
      . query ( { ... query , format } )
      . send ( body || { } )
      . set ( headers )
      . end ( ( err , res ) => {
        if ( err || ! res )
          return resolve ( {
            status : err . status || 500 ,
            statusText : err . response . text || 'Internal Server Error' ,
            headers : err . headers || { } ,
            body : err . response . text || null ,
          } ) ;
        const response : TransportResponse < ResponseType > = {
          status : res . status ,
          statusText : res . text ,
          headers : res . headers ,
          body : res . body ,
        } ;
        resolve ( response ) ;
      } )
  ) ;
}

const service = what3words ( API_KEY , config , { transport : customTransport } ) ;
service
  . availableLanguages ( )
  . then ( ( { languages } ) => console . log ( 'Available languages' , languages ) ) ;

Autosuggest

 import {
  AutosuggestClient ,
  AutosuggestOptions ,
  AutosuggestResponse ,
} from '@what3words/api' ;

const API_KEY = '<YOUR_API_KEY>' ;
const client : AutosuggestClient = AutosuggestClient . init ( API_KEY ) ;
const options : AutosuggestOptions = {
  input : 'filled.count.s' ,
} ;
client
  . run ( options )
  . then ( ( res : AutosuggestResponse ) =>
    console . log ( `suggestions for " ${ options . input } "` , res )
  ) ;

轉換為坐標

 import {
  ConvertToCoordinatesClient ,
  ConvertToCoordinatesOptions ,
  FeatureCollectionResponse ,
  LocationGeoJsonResponse ,
  LocationJsonResponse ,
} from '@what3words/api' ;

const API_KEY = '<YOUR_API_KEY>' ;
const client : ConvertToCoordinatesClient =
  ConvertToCoordinatesClient . init ( API_KEY ) ;
const options : ConvertToCoordinatesOptions = { words : 'filled.count.soap' } ;

// If you want to retrieve the JSON response from our API
client
  . run ( { ... options , format : 'json' } ) // { format: 'json' } is the default response
  . then ( ( res : LocationJsonResponse ) =>
    console . log ( 'Convert to coordinates' , res )
  ) ;

// If you want to retrieve the GeoJsonResponse from our API
client
  . run ( { ... options , format : 'geojson' } )
  . then ( ( res : FeatureCollectionResponse < LocationGeoJsonResponse > ) =>
    console . log ( 'Convert to coordinates' , res )
  ) ;

轉換為三個單詞地址

 import {
  ConvertTo3waClient ,
  ConvertTo3waOptions ,
  FeatureCollectionResponse ,
  LocationGeoJsonResponse ,
  LocationJsonResponse ,
} from '@what3words/api' ;

const API_KEY = '<YOUR_API_KEY>' ;
const client : ConvertTo3waClient = ConvertTo3waClient . init ( API_KEY ) ;
const options : ConvertTo3waOptions = {
  coordinates : { lat : 51.520847 , lng : - 0.195521 } ,
} ;

// If you want to retrieve the JSON response from our API
client
  . run ( { ... options , format : 'json' } ) // { format: 'json' } is the default response
  . then ( ( res : LocationJsonResponse ) => console . log ( 'Convert to 3wa' , res ) ) ;

// If you want to retrieve the GeoJsonResponse from our API
client
  . run ( { ... options , format : 'geojson' } )
  . then ( ( res : FeatureCollectionResponse < LocationGeoJsonResponse > ) =>
    console . log ( 'Convert to 3wa' , res )
  ) ;

可用語言

 import {
  AvailableLanguagesClient ,
  AvailableLanguagesResponse ,
} from '@what3words/api' ;

const API_KEY = '<YOUR_API_KEY>' ;
const client : AvailableLanguagesClient = AvailableLanguagesClient . init ( API_KEY ) ;
client
  . run ( )
  . then ( ( res : AvailableLanguagesResponse ) =>
    console . log ( 'Available Languages' , res )
  ) ;

網格部分

 import {
  GridSectionClient ,
  GridSectionOptions ,
  FeatureCollectionResponse ,
  GridSectionGeoJsonResponse ,
  GridSectionJsonResponse ,
} from '../src' ;

const API_KEY = '<YOUR_API_KEY>' ;
const client : GridSectionClient = GridSectionClient . init ( API_KEY ) ;
const options : GridSectionOptions = {
  boundingBox : {
    southwest : { lat : 52.208867 , lng : 0.11754 } ,
    northeast : { lat : 52.207988 , lng : 0.116126 } ,
  } ,
} ;

// If you want to retrieve the JSON response from our API
client
  . run ( { ... options , format : 'json' } ) // { format: 'json' } is the default response
  . then ( ( res : GridSectionJsonResponse ) => console . log ( 'Grid Section' , res ) ) ;

// If you want to retrieve the JSON response from our API
client
  . run ( { ... options , format : 'geojson' } ) // { format: 'json' } is the default response
  . then ( ( res : FeatureCollectionResponse < GridSectionGeoJsonResponse > ) =>
    console . log ( 'Grid Section' , res )
  ) ;

所請求的框必須從角落到角度不得超過4公里，否則將返回BadBoundingBoxtoobig錯誤。緯度必須為> = -90和<= 90，但是允許縱向包裹在180左右。要指定一個越過反梅里德人的邊界框，請使用大於180的經度。

輸入驗證

 import {
  GridSectionClient ,
  GridSectionOptions ,
  FeatureCollectionResponse ,
  GridSectionGeoJsonResponse ,
  GridSectionJsonResponse ,
} from '../src' ;

const API_KEY = '<YOUR_API_KEY>' ;
const client : GridSectionClient = GridSectionClient . init ( API_KEY ) ;
const options : GridSectionOptions = {
  boundingBox : {
    southwest : { lat : 52.208867 , lng : 0.11754 } ,
    northeast : { lat : 52.207988 , lng : 0.116126 } ,
  } ,
} ;

// Search a string for any character sequences that could be three word addresses
client . findPossible3wa ( 'filled.count.soap' ) ; // returns ['filled.count.soap']
client . findPossible3wa (
  'this string contains a three word address substring: filled.count.soap'
) ; // returns ['filled.count.soap']
client . findPossible3wa ( 'filled.count' ) ; // returns []

// Search a string for any character sequences that could be three word addresses
client . isPossible3wa ( 'filled.count.soap' ) ; // returns true
client . isPossible3wa (
  'this string contains a three word address substring: filled.count.soap'
) ; // returns false
client . isPossible3wa ( 'filled.count' ) ; // returns false

// Search a string for any character sequences that could be three word addresses
client . isValid3wa ( 'filled.count.soap' ) ; // returns Promise<true>
client . isValid3wa (
  'this string contains a three word address substring: filled.count.soap'
) ; // returns Promise<false>
client . isValid3wa ( 'filled.count.negative' ) ; // returns Promise<false>