Skip to content

Latest commit

 

History

History
228 lines (192 loc) · 6.16 KB

README.md

File metadata and controls

228 lines (192 loc) · 6.16 KB
Raw

promise-lua

promise-lua is an es6-javascript Promise mechanism implemented by Lua, with the exception that then function is replaced by thenCall since then is a keyword of Lua languange.

Installation

You can install promise-lua using LuaRocks:

$ luarocks install promise-lua

Usage

To create Promise object, simply use Promise.new(func) in which func is of following form:

function (resolve, reject)
    -- Do any async or sync operations.
    -- When success, call `resolve`.
    -- When failed, call `reject`.
end

Promise(func) is a shorthand of Promise.new(func). After create, do thenCall to actually resolve or reject.

local p = ... -- p is a Promise object 
p:thenCall(function (value)
    -- resolved with value
end, function (reason)
    -- rejected with reason
end)

-- Equivalent to
local p = ... -- p is a Promise object 
p:thenCall(function (value)
    -- resolved with value
end)
:catch(function (reason)
    -- rejected with reason
end)

Since thenCall returns a new Promise object, you can chain multiple thenCall as following:

local p = ... -- p is a Promise object
p:thenCall(function (value)
    -- resolved with value
    return value
end)
:thenCall(function (value)
    -- resolve from last resolved result
end)

There are more methods defined in Promise object, like catch and finally. For more information, please check out this doc.

Here is a full basic usage example. Suppose there exists a function called setTimeout, which calls a function or evaluates an expression after a specified number of milliseconds.

-- Note that all the parameters after `func` are passed to the `func` as its parameters.
setTimeout(milliseconds, func, ...)

Now we generate a random integer. If the integer is even, we resolve with it. Otherwise, we reject it with an error message.

local Promise = require 'promise'

Promise(function(resolve, reject)
    setTimeout(1000, function()
        math.randomseed(os.time())
        local num = math.random(10)
        if num % 2 == 0 then
            resolve(num)
        else
            local errMsg = string.format('[ERROR] Expect an even number, but get %d', num)
            reject(errMsg)
        end
    end)
end)
:thenCall(function(value)
    print('an even number', value)
end)
:catch(function(err)
    print(err)
end)
:finally(function()
    print('all done')
end)

The thenCall branch will be executed if the integer is even, otherwise the catch branch will be. No matter what branch is executed, the function defined in finally will eventually be called.

More methods

Promise.resolve

Returns a new Promise object that is resolved with the given value. For more information, checkout doc.

local Promise = require 'promise'

local p = Promise.resolve(3)
:thenCall(function(value)
    print('promise resolve a value: ', value)
    return value
end)

Promise.resolve({
    thenCall = function()
        print('thenable called')
    end
})

Promise.resolve(p)
:thenCall(function(value)
    print('resolve from a promise: ', value)
end)

--[[
Output:
    promise resolve a value: 3
    thenable called
    resolve from a promise: 3
--]]

Promise.reject

Returns a new Promise object that is rejected with the given reason. For more information, checkout doc.

local Promise = require 'promise'

Promise.reject('[ERROR] this is an error msg')
:catch(function(reason)
    print('catch an error: ', reason)
end)

--[[
Output:
    catch an error: [ERROR] this is an error msg
--]]

Promise.race

Wait until any of the promises is resolved or rejected. For more information, checkout doc.

local Promise = require 'promise'

local p1 = Promise.resolve(3)

local p2 = Promise(function (resolve, reject)
    setTimeout(1000, resolve, true)
end)

local p3 = Promise(function (resolve, reject)
    setTimeout(2000, resolve, 'hello')
end)

Promise.race({p1, p2, p3})
:thenCall(function (value)
    print('winner value:', value)
end)

--[[
Output:
    winner value: 3
--]]

Promise.all

Wait for all promises to be resolved, or for any to be rejected. For more information, checkout doc.

local Promise = require 'promise'

local p1 = Promise.resolve(3)

local p2 = Promise(function (resolve, reject)
    setTimeout(1000, resolve, true)
end)

local p3 = Promise(function (resolve, reject)
    setTimeout(2000, resolve, 'hello')
end)

Promise.all({p1, p2, p3})
:thenCall(function (value)
    print('first one: all done!')
end)
:catch(function (reason)
    print('first one rejected!')
end)

local p4 = Promise(function (resolve, reject)
    setTimeout(2000, reject, '[ERROR]')
end)

Promise.all({p1, p2, p3, p4})
:thenCall(function (value)
    print('second one: all done!')
end)
:catch(function (reason)
    print('second one rejected!')
end)

--[[
Output:
    first one: all done!
    second one rejected!
--]]

Promise.serial

WARNING: This is still in verification phase, so use at your own risk.

Since promise runs immediately when created, it is impossible to run created promises one by one. However, created tasks have no such limitation. To do so, we create multiple task functions, which parameters are resolve and reject functions, as follows:

-- Task 1
local t1 = function (resolve, reject)
    setTimeout(1000, resolve, true)
end

-- Task 2
local t2 = function (resolve, reject)
    setTimeout(2000, resolve, 'hello')
end

Now we pass all those defined tasks to Promise.serial, and they will be done one by one.

local Promise = require 'promise'

Promise.serial({t1, t2})
:thenCall(function()
    print('all done')
end)

License

MIT License