web-ip-util v0.0.1

前端获取 ip 及位置信息工具

快速开始

安装

npm install web-ip-util --save

使用

import { getDefaultIpInfo } from 'web-ip-util'

getDefaultIpInfo([
  {
    id: 'qq',
    data: {
      key: '输入腾讯位置服务申请的key'
    }
  }
]).then(res => {
  console.log('res', res)
})

API 方法

getDefaultIpInfo

该方法用于载入默认配置

• 参数 ElementTYpe[]

• 示例

getDefaultIpInfo([
  {
    id: 'qq', // 匹配默认配置对应的腾讯位置服务
    data: {
      // 由于腾讯位置服务的key是私有的，需要自行配置，然后工具会把data参数合并到默认配置中
      key: '输入腾讯位置服务申请的key'
    }
  }
]).then(res => {
  console.log('res', res)
})

目前默认配置了如下服务：

• 腾讯位置服务 (jsonp)

  腾讯位置服务 IP 定位配置限额如下：

• 太平洋 (jsonp)
• IP Geolocation API (jsonp)
• IP.SB Free API (jsonp)

getIpInfo

该方法用于载入自定义配置 (多个)

• 参数 ElementTYpe[]

• 示例

getIpInfo([
  {
    id: 'ip-api',
    url: 'http://ip-api.com/json',
    data: {
      callback: 'callback',
      lang: 'zh-CN'
    },
    jsonpCallback: 'callback',
    resMapping: {
      ip: 'query',
      province: 'regionName'
    }
  }
]).then(res => {
  console.log('res', res)
})

getElementPromise

该方法用于载入自定义配置 (单个)

• 参数 ElementTYpe
• 示例

getIpInfo({
  url: 'http://ip-api.com/json',
  data: {
    callback: 'callback'
  },
  jsonpCallback: 'callback',
  resMapping: {
    ip: 'query'
  }
}).then(res => {
  console.log('res', res)
})

参数类型

ElementTYpe

ResMapping

返回结果多层级时，中间用 . 分隔