Node.js 如何为NPM软件包编写安装程序
我正在编写我的第一个node.js包,以帮助REST API更易于使用,并且我在格式化包以允许使用包的人在其应用程序中执行以下操作时遇到了困难Node.js 如何为NPM软件包编写安装程序,node.js,npm,package,Node.js,Npm,Package,我正在编写我的第一个node.js包,以帮助REST API更易于使用,并且我在格式化包以允许使用包的人在其应用程序中执行以下操作时遇到了困难 var Water= require("water-reservation"); var water = Water({username: myusername, password: mypassword}); // Problem here because Water({}) needs to do a REST call to get a bea
var Water= require("water-reservation");
var water = Water({username: myusername, password: mypassword});
// Problem here because Water({}) needs to do a REST call to get a bearer
// token to use the API I am trying to simplify. Thus, it tries to
// get_water(callabck) before the bearer_token var is set in my package.
water.get_water(function(err, result){
if(err){
console.log(err);
console.log("----------------------------------------------");
}
else{
console.log(result);
console.log("----------------------------------------------");
}
});
在我当前的设置中,我获取用户的用户名和密码并将其传递给REST端点,以获取我在包的所有REST调用中使用的承载令牌。在我设置包中的bearer\u token变量之前,异步性质将在用户文件中调用get\u water
以下是我的软件包的外观:
var request = require('request');
var bearer_token = "";
var api_url = "";
var Water = function(credentials){
api_url = credentials.api_url;
var username = credentials.username;
var password = credentials.password;
get_bearer_token(username, password, function(err, access_token){
bearer_token = access_token;
});
};
function get_bearer_token(username, password, callback){
var request_options = {
url: api_url + "/auth",
method: "GET",
'auth': {
'user': username,
'pass': password
}
};
request(request_options, function(err, res, body){
if(err) {
return callback("Water Initialization Error: " + err, null);
}
else {
return callback(null, body);
}
});
}
// Get water
Water.prototype.get_water = function(callback) {
var request_options = {
url: api_url + "/water",
method: "GET",
'auth': {
'bearer': bearer_token
}
};
request(request_options, function(err, res, body){
if(err) {
return callback(err, null);
}
else{
return callback(null, body);
}
});
};
// more package functions...
module.exports = Water;
我正在试图找到一种方法来进行设置,以便用户可以使用如上所述的软件包。我不喜欢这种风格,但它似乎是用户最容易理解和使用的
我能想到的解决这个问题的唯一方法是向Water({})添加一个回调,但是如果用户将所有与Water相关的代码都包装在回调中,这会造成很大的混乱。例如,我知道可以通过查看软件包来完成,但我仍然可以围绕他们是如何完成的来思考。任何帮助都将不胜感激,谢谢。当他们提出请求时,您应该将获取代币的责任委托给他们。这样,软件包会立即初始化。为了提高效率,您可以在第一次获取令牌时对其进行缓存。我在这里举了一个例子,但您可以使用类似async的东西来整理它:
var request = require('request');
var Water = function (credentials) {
this.api_url = credentials.api_url;
this.username = credentials.username;
this.password = credentials.password;
return this;
};
Water.prototype.get_bearer_token = function (callback) {
// We already have the bearer token, so return straight away
if (this.bearer_token) return callback(null, this.bearer_token);
var self = this;
var request_options = {
url: this.api_url + "/auth",
method: "GET",
'auth': {
'user': this.username,
'pass': this.password
}
};
request(request_options, function(err, res, body){
if(err) {
return callback("Water Initialization Error: " + err, null);
}
else {
self.bearer_token = body;
return callback(null, body);
}
});
}
// Get water
Water.prototype.get_water = function(callback) {
var self = this;
this.get_bearer_token(function (err, token) {
if (err) return callback(err);
var request_options = {
url: self.api_url + "/water",
method: "GET",
'auth': {
'bearer': token
}
};
request(request_options, function(err, res, body){
if(err) {
return callback(err, null);
}
else{
return callback(null, body);
}
});
});
};
// more package functions..
module.exports = Water;
要使用它:
var Water = require('water-reservation');
var water = new Water({
username: 'username',
password: 'pass',
api_url: 'http://example.com'
});
water.get_water(function (err, res) {
});
节点twitter
包似乎没有在原型函数中发出任何异步请求。也许我应该让用户提供他们的承载令牌,而不是在设置中执行rest请求。尽管如此,我还是希望能为他们提供帮助,让他们更容易使用软件包。很酷,感谢您提供的解决方案和示例!因此,对于我用这个包生成的每个函数,我都应该包含一个回调,用于获取令牌this.get_bearer\u token(函数(err,token){};)
我想知道是否有办法避免在包的每个方法中重复相同的回调,以增加可读性并减少冗余。为了避免嵌套回调,您可以使用异步瀑布(或Promissions)将其平坦化。然而,如果它只是获得承载令牌,然后提出请求,我可能不会麻烦。