npm 包 canibekiked-api 使用教程

前言

在前端开发中，有时候我们需要获取一些关于 IP 地址相关的信息，例如：国家、地区、经纬度等等。这时候我们就可以使用第三方的 API 来获取这些信息。本文要介绍的是 canibekiked-api 这个 npm 包。这个包可以帮助我们快速轻松地获取 IP 地址相关信息。

安装

我们可以通过 npm 安装 canibekiked-api。打开终端（或命令行工具），输入以下命令：

npm install canibekiked-api

安装完成之后，我们就可以在需要的文件中引入它：

const canibekiked = require('canibekiked-api');

使用

canibekiked-api 提供了两个方法：lookup() 和 bulkLookup()。

lookup()

lookup() 方法可以传入一个 IP 地址，并返回一个 Promise。它会返回一个对象，包含了 IP 地址相关的信息，例如：国家、地区、经纬度等等。以下是一个示例代码：

const canibekiked = require('canibekiked-api');

canibekiked.lookup('8.8.8.8')
    .then(response => console.log(response))
    .catch(error => console.log(error));

以上代码会将 8.8.8.8 传入 lookup() 方法中，并输出获取到的 IP 地址信息。

bulkLookup()

bulkLookup() 方法可以传入一个 IP 地址数组，并返回一个 Promise。它会返回一个数组，其中每一项都是一个对象，包含了对应 IP 地址的信息。以下是一个示例代码：

const canibekiked = require('canibekiked-api');

canibekiked.bulkLookup(['8.8.8.8', '119.29.29.29'])
    .then(response => console.log(response))
    .catch(error => console.log(error));

以上代码会将 ['8.8.8.8', '119.29.29.29'] 传入 bulkLookup() 方法中，并输出获取到的 IP 地址信息。

注意事项

apiToken

canibekiked-api 需要使用 API Token，可以在官网注册并获取。在使用时，需要将 Token 传入第一个参数中：

const canibekiked = require('canibekiked-api')('Your API Token');

返回值

无论是 lookup() 方法还是 bulkLookup() 方法，它们返回的都是 Promise，所以我们可以使用 then() 和 catch() 来获取结果或者处理错误。

结语

可以看到，使用 canibekiked-api 能够方便、简单地获取 IP 地址相关的信息。同时，本文也对使用方法进行了详细介绍。希望可以对初学者在开发过程中有所帮助！

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066c92ccdc64669dde5a22