1mbsite-node 中文文档教程

Question

1mbsite NodeJS

1mbsite NodeJS 是一个 NPM 包，用于与 1mbsite API 通信。

注意：这个包中没有函数是同步的，它们都有回调参数，当请求包返回数据时运行 在

Getting Started

开始之前，您必须通过执行以下命令安装 NPM 包：

npm install 1mbsite-node --save

使用此 API 时，您需要提供您的1mbsite account key，您可以通过在这里登录并点击设置中的API类别来获取您的账户密钥。 在那里你应该看到你的帐户密钥。

完成此操作后，您可以通过执行以下操作来请求 1mbsite-node：

const mbsite = require("1mbsite-node");

在请求 1mbsite-node 库之后，您需要通过执行以下操作来创建一个新的 API 实例:

const API = mbsite.API;

现在您可以使用 API 了。

Examples

Verifying your API key

注意：此过程不是必需的，因为此方法是在 API 类的构造函数中调用的。

API.verifyKey(function(result){
// Code here will be executed when the request has returned data
});

verifyKey() 方法需要一个回调参数。 JSON 对象通过回调传递并具有“错误”键和“数据键”。 此处的数据键未使用，但错误键在成功时为真，或在失败时为错误字符串。

Deploying to your 1mb.site

API.deploy("resource", "code", function(result){
// Code here will be executed when the request has returned data
});

deploy() 方法需要一个用于要部署到的资源的字符串参数、另一个用于要部署的代码的字符串参数和一个回调参数。 回调参数通过一个 JSON 对象传递，该对象具有键“error”和“data”。 再一次，数据键未被使用，但错误键要么在成功时返回 true，要么在失败时返回错误字符串。

Viewing a 1mb.site resource

API.viewSite("site name", "resource", function(result){
// Code here will be executed when the request has returned data
});

viewSite() 方法需要一个字符串参数作为站点名称（用户名），另一个字符串参数作为您要查看的资源和一个回调参数。 回调参数通过键为“error”和“data”的 JSON 对象传递。 如果没有错误，则错误键将为假，数据键将为所提供资源的代码字符串。 如果有错误，错误将是字符串错误，数据键将为假。

Listing a sites resources

API.listResources("site name", function(result){
// Code here will be executed when the request has returned data
});

listResources() 方法需要站点名称（用户名）的字符串参数和回调参数。 回调参数通过键为“error”和“data”的 JSON 对象传递。 如果有错误，错误键将是一个错误字符串，但如果没有错误，错误将为假，数据键将是一个包含站点上所有资源的数组。

API 使用 :heart: 由 TwistedAsylumMC 制作！