Home Manual Reference Source
Repository
import GeoService from '@eastsideco/escshopify/src/plugins/geoservice/GeoService.js'
public class | source

GeoService

Extends:

evee~Evee → GeoService

Provides access to the ESC Geoservice.

Constructor Summary

Public Constructor
public

Create a new instance of GeoService.

Member Summary

Public Members
public

api: API

public
Private Members
private

Method Summary

Public Methods
public

Retrieves currency info.
public

Retrieves geolocation information.

Public Constructors

public constructor() source

Create a new instance of GeoService.

Public Members

public api: API source

public cacheLookups: Boolean source

Private Members

private _cachedLookups: Object<String, Object> source

Public Methods

public async getCurrencyInfo(): Promise<GSCurrencyResponse, Error> source

Retrieves currency info.

Return:

Promise<GSCurrencyResponse, Error>

public async lookupGeo(ip: String): Promise<GSGeoResponse|Error> source

Retrieves geolocation information.

Params:

NameTypeAttributeDescription
ip String
  • optional

IP address to get information on. If not supplied, uses local IP.

Return:

Promise<GSGeoResponse|Error>