异步getter的命名约定

时间:2013-06-11 14:43:54

标签: javascript callback naming-conventions getter

对于同步getter函数,命名约定是明确定义的:

var getFerby = function(){
    ..
    return ferby;
};

但是,如果我想要的ferby不是本地(同步)可用的,那么常见的方法是使用回调来处理这种情况:

/**
 * Asynchronously gets a ferby and passes it to the callback.
 *  
 *     Once the ferby is retrieved, these rules MUST be followed:
 *       1) Don't feed it after midnight.
 *       2) Don't give it water.
 *       3) Don't let it near bright light.  
 *
 * @param {ferbyCallback} callback - The callback function that expects a ferby.
 */
var fooFerby = function(callback){
    getFerbyLoader().load(function(ferby){
        callback(ferby);
    });
};

/**
 * The callback for the fooFerby function.
 *
 * @callback ferbyCallback
 * @param ferby The ferby
 */

fooFerby有什么好的命名约定,以便我知道它希望回调?

2 个答案:

答案 0 :(得分:3)

我使用前缀“fetch”,而不是异步getter的“get”。

这个想法是,如果它不是本地可用的,你需要获取它。

答案 1 :(得分:1)

.NET使用BeginDoAction。我喜欢JavaScript中的相同方法。因此,在您的情况下,函数将是beginGetFerby

NodeJs采用大多数方法都是异步的约定,并且同步方法具有“同步”后缀,例如, doActionSync。您可以执行相反的操作,并使用“Async”后缀,因此您的函数将为getFerbyAsync。我也喜欢这种方法。