异步getter的命名约定

Question

对于同步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以便我知道它希望回调？

Answer 1

对于异步 getter，我使用前缀“fetch”，而不是“get”。

这个想法是，如果它在本地不可用，则需要获取它。

Answer 2

.NET 使用 BeginDoAction。我喜欢 JavaScript 中的相同方法。所以在你的情况下，该函数将是beginGetFerby.

NodeJs 遵循大多数方法都是异步的约定，同步方法有一个“Sync”后缀，例如 doActionSync。您可以做相反的事情，并有一个“Async”后缀，所以您的函数将是getFerbyAsync. 我也喜欢这种方法。