Class BaseProvider

constructor

• new BaseProvider(__namedParameters?): BaseProvider

• Parameters

  • __namedParameters: BaseProviderOpts = {}

  Returns BaseProvider

OptionalapiKey

apiUrl

apiUrlPlaceholder

fetch

fetchOpts

headers

getOpts

• getOpts(body?, headers?, method?): {
      body: unknown;
      headers: {};
      method: RequestMethod;
  }

• Parameters

  • body: unknown = undefined
  • headers: Record<string, string> = {}
  • method: RequestMethod = "GET"

  Returns {
      body: unknown;
      headers: {};
      method: RequestMethod;
  }

  • body: unknown

  • headers: {}

  • method: RequestMethod

isValidUrl

• isValidUrl(url): url is string

• Parameters

  • url: undefined | string

  Returns url is string

lookup

• lookup(ipAddress): Promise<IPGeolocationInfo>

• Parameters

  • ipAddress: string

  Returns Promise<IPGeolocationInfo>

request

• request<T>(path, body?, headers?, method?): Promise<ProviderResponse<T>>

• The standard method for requesting the API, if necessary, you can override how it is done in the example

  Type Parameters

  • T = unknown

  Parameters

  • path: string
  • body: unknown = undefined
  • headers: Record<string, string> = {}
  • method: RequestMethod = "GET"

  Returns Promise<ProviderResponse<T>>

updateData

• updateData(__namedParameters?): void

• Parameters

  • __namedParameters: Partial<BaseProviderOpts> = {}

  Returns void