Forest Logo
search
package_2

signal

By @cometahn1042f

Roblox

Mirrored

Signal

Signal is a high-performance, strictly-typed event signaling library for Luau on Roblox. It features decoupled fire/subscribe interfaces, coroutine thread pooling for zero-allocation dispatches, and stateful projection signals.

Documentation Index

  • API Reference: createSignal, createReadableSignal, Subscription, Signal, FireSignal, ReadableSignal.
  • Architecture & Design: Thread pooling, doubly-linked node list model, and decoupled fire functions.
  • Performance & Memory Profile: Algorithmic complexity and thread allocation benchmarks.
  • Failure Modes & Exception Guarantees: Safe node unlinking during iteration and coroutine exception isolation.
  • Executable Examples: Executable Luau code samples for signals and readable signals.

Quick Start

local Signal = require(path.to.Signal)

-- Create a writable signal
local signal, fire = Signal.createSignal()

-- Subscribe to signal
local subscription = signal:subscribe(function(message: string)
    print("Received:", message)
end)

-- Fire signal using returned fire function
fire("Hello, Signal!")

-- Unsubscribe
subscription:unsubscribe()

Package Details

Install command (Click to copy)


Version

0.1.3

License

MIT

check_circle

Safe for commercial use

Automated license review — not legal advice.