Vow

A modern, high-performance, strictly-typed Promise/A+ implementation for Luau in Roblox.

Features

• Strictly Typed: Full --!strict mode compatibility, passing generic Types smoothly.
• Task Library Powered: Uses Roblox's modern task library for optimal scheduling.
• Advanced Combinators: Fully functional methods like all, race, some, allSettled, fold, and each.
• Cancellation Propagation: Robust up/down tree cancellation handling.
• Structured Error Handling: Includes a highly detailed Vow.Error type giving stack traces, structured contexts, and nested parent errors.

Installation

Add to your wally.toml:

[dependencies]
Vow = "nazumahk/vow@1.0.0"

Quick Start

local Vow = require(path.to.Vow)

local myVow = Vow.new(function(resolve, reject, onCancel)
    local task = task.delay(1, function()
        resolve("Async Task Complete!")
    end)
    
    onCancel(function()
        task.cancel(task)
    end)
end)

myVow:andThen(function(result)
    print(result) -- "Async Task Complete!"
end):catch(function(err)
    warn("Failed:", err)
end)

Documentation

• Why Use Vow? -- Benefits and Case Studies
• Technical Architecture -- Internal Design & Optimizations
• API Reference -- Full Method Specification

License

MIT