An open API service indexing awesome lists of open source software.

https://github.com/owsas/owapis-js

Otherwise SAS Apis JS SDK
https://github.com/owsas/owapis-js

js otherwise owsas sdk

Last synced: 16 days ago
JSON representation

Otherwise SAS Apis JS SDK

Awesome Lists containing this project

README

          

# owapis-js

This is the official ES2015 JS SDK for the Otherwise SAS Apis (owsas.com)

## Installation

```
$> npm i --save owapis-js
```

## Usage
```js
const OwApis = require('owapis-js');

// initialize first (obligatory)
OwApis.initialize('');
````

## API docs

```js
/**
* Reverse geocodes any given lat lng using Google
* @param {number} lat
* @param {number} lang
* @return {Promise}
*/
static reverseGeocode(lat, lng);

/**
* Geocodes any given string using Google
* @param {string} string The string to geocode
* @return {Promise}
*/
static geocode(string);

/**
* Gets own ip information using GeoLite2-City
* @return {Promsie}
*/
static getOwnIPInfo();

/**
* Gets ip information using GeoLite2-City
* @param {string} ipAddr The ip address
* @return {Promsie}
*/
static getIPInfo(ipAddr);

/**
* Gets information about a country with given countryCode
* @param {string} countryCode
* @return {Promsie}
*/
static getCountryInfo(countryCode);

/**
* Gets information about a country with given countryCode
* @param {string} countryCode
* @return {Promsie}
*/
static getCountryInfoByCCA3(countryCode);

/**
* Gets information about a country with given countryCode
* @param {string} countryCode
* @return {Promsie}
*/
static getCountryInfoByCCA2(countryCode);

/**
* Gets information about a country with given code
* @param {string} code
* @return {Promsie}
*/
static getCountriesByCallingCode(code);

/**
* Gets information about a country with given code
* @param {string} code
* @return {Promsie}
*/
static getCountriesByCurrencyCode(code);

/**
* Gets all the world languages
* @return {Promsie}
*/
static getWorldLanguages();

/**
* Gets information about a language with given langCode
* @param {string} langCode
* @return {Promsie}
*/
static getLanguageInfo(langCode);

/**
* Makes a request to the OWSAS Api. Feel free to use it if you
* know the urls of the API
* @param {string} method
* @param {string} url
* @param {{query:any, body:any}} options
* @return {Promise|Promise}
*/
static _request(method, url, options = {});
```

## Credits
Juan Camilo Guarín Peñaranda
Otherwise SAS, [http://owsas.com](http://owsas.com)
Hecho con <3 en Colombia

## License
MIT