Initial commit

Author: Blerru

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false
+
+[*.lua]
+indent_style = tab
+
+[*.json]
+indent_style = space

.github/workflows/publish-docs.yml

@@ -0,0 +1,22 @@
+name: main
+on:
+    push:
+        branches: ["main"]
+jobs:
+    status:
+        runs-on: ubuntu-latest
+        name: Publish docs to GitHub Pages
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: "22"
+            - run: npm i -g moonwave@latest
+            - name: Publish
+              run: |
+                  git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+                  git config --global user.email "support+actions@github.com"
+                  git config --global user.name "github-actions-bot"
+                  moonwave build --publish
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,9 @@
+# Project model file
+/out
+
+# Roblox Studio lock files
+/*.rbxlx.lock
+/*.rbxl.lock
+
+# Sourcemaps
+sourcemap.json

LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2025 Blerru
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,30 @@
+# BindableEventWrapper
+
+A BindableEventWrapper is an object that wraps a [BindableEvent](https://create.roblox.com/docs/reference/engine/classes/BindableEvent) and provides an API similar to that of normal signal libraries.
+
+## Usage
+
+To use this, simply create a new instance by calling new. Afterwards, use the created instance like an [RBXScriptSignal](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal). Unlike an RBXScriptSignal, there is a [Fire](https://blru.github.io/roblox-bindable-event-wrapper/api/BindableEventWrapper#Fire) method to fire the event.
+
+```lua
+local BindableEventWrapper = require(Path.To.Module)
+
+local foodConsumed = BindableEventWrapper.new()
+
+foodConsumed:Connect(function(consumer: Player, kind: string)
+    print(consumer.Name .. " ate a " .. kind .. ".")
+end)
+
+foodConsumed:Fire(someone, "carrot")
+```
+
+For more information, refer to the [documentation](http://blru.github.io/roblox-bindable-event-wrapper/api/BindableEventWrapper).
+
+## Why use this?
+
+Uh..
+
+> "Your scientists were so preoccupied with whether or not they could, they didn't stop to think if they should."
+
+Realistically, it is oftentimes better to use an actual signal implementation, such as [FastSignal](https://github.com/RBLXUtils/FastSignal), especially if you want to get around the [limitations](https://create.roblox.com/docs/scripting/events/bindable#argument-limitations) imposed by traditional BindableEvents.
+

aftman.toml

@@ -0,0 +1,7 @@
+# This file lists tools managed by Aftman, a cross-platform toolchain manager.
+# For more information, see https://github.com/LPGhatguy/aftman
+
+# To add a new tool, add an entry to this table.
+[tools]
+rojo = "rojo-rbx/rojo@7.5.1"
+# rojo = "rojo-rbx/rojo@6.2.0"

default.project.json

@@ -0,0 +1,6 @@
+{
+    "name": "BindableEventWrapper",
+    "tree": {
+        "$path": "src"
+    }
+}

moonwave.toml

@@ -0,0 +1,11 @@
+title = "BindableEventWrapper"
+gitRepoUrl = "https://github.com/blru/roblox-bindable-event-wrapper"
+gitSourceBranch = "main"
+changelog = false
+
+[home]
+enabled = false
+includeReadme = false
+
+[docusaurus]
+tagline = "A wrapper around a BindableEvent"

scripts/build

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+mkdir -p ./out
+rojo build --output ./out/bindable-event-wrapper.rbxm default.project.json

src/init.luau

@@ -0,0 +1,120 @@
+--[=[
+    @class BindableEventWrapper
+
+    A wrapper around a [BindableEvent] that exposes a similar API to that of a normal signal library.
+
+    Please note that this has the same [limitations](https://create.roblox.com/docs/scripting/events/bindable#argument-limitations) as a regular BindableEvent.
+
+    ```lua
+    local roundEnded = BindableEventWrapper.new()
+
+    foodEaten:Connect(function(winner)
+        print(winner .. " won the round!")
+    end)
+
+    foodEaten:Fire("Jerry")
+    ```
+]=]
+local BindableEventWrapper = {}
+BindableEventWrapper.__index = BindableEventWrapper
+
+type BindableEventWrapper = typeof(setmetatable({} :: {}, BindableEventWrapper))
+
+--[=[
+    @prop _internal BindableEvent
+    @private
+    @within BindableEventWrapper
+
+    The underlying bindable event used by the class
+]=]
+
+--[=[
+    @within BindableEventWrapper
+    @param event BindableEvent? -- If this is not nil, the wrapper will wrap the provided [BindableEvent] instead of creating a new one.
+
+    Instantiates a new BindableEventWrapper.
+]=]
+function BindableEventWrapper.new(event: BindableEvent?)
+	assert(
+		event == nil
+			or (typeof(event) == "Instance" and event:IsA("BindableEvent")),
+		"event must be nil or an instance of BindableEvent"
+	)
+
+	if event == nil then
+		event = Instance.new("BindableEvent")
+	end
+
+	local self = {
+		_inner = event,
+	}
+
+	setmetatable(self, BindableEventWrapper)
+
+	return self
+end
+
+--[=[
+    @within BindableEventWrapper
+
+    Fires the internal [BindableEvent].
+
+    See [BindableEvent:Fire]
+]=]
+function BindableEventWrapper.Fire(self: BindableEventWrapper, ...: any)
+	self._inner:Fire(...)
+end
+
+--[=[
+    @within BindableEventWrapper
+
+    Connects to the internal [BindableEvent's Event](https://create.roblox.com/docs/reference/engine/classes/BindableEvent#Event) and returns the [RBXScriptConnection](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptConnection) representing it.
+
+    See [RBXScriptSignal:Connect]
+]=]
+function BindableEventWrapper.Connect(
+	self: BindableEventWrapper,
+	callback: (...any) -> ()
+): RBXScriptConnection
+	return self._inner.Event:Connect(callback)
+end
+
+--[=[
+    @within BindableEventWrapper
+
+    See [RBXScriptSignal:ConnectParallel]
+]=]
+function BindableEventWrapper.ConnectParallel(
+	self: BindableEventWrapper,
+	callback: (...any) -> ()
+): RBXScriptConnection
+	return self._inner.Event:ConnectParallel(callback)
+end
+
+--[=[
+    @within BindableEventWrapper
+
+    Connects to the [internal BindableEvent's Event](https://create.roblox.com/docs/reference/engine/classes/BindableEvent#Event) such that the connection is disconnected after the first event is delivered. Returns the [RBXScriptConnection](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptConnection) representing the connection.
+
+    See [RBXScriptSignal:Once]
+]=]
+function BindableEventWrapper.Once(
+	self: BindableEventWrapper,
+	callback: (...any) -> ()
+): RBXScriptConnection
+	return self._inner.Event:Once(callback)
+end
+
+--[=[
+    @within BindableEventWrapper
+    @yields
+
+    Yields until the internal [BindableEvent's Event](https://create.roblox.com/docs/reference/engine/classes/BindableEvent#Event) fires. Returns the arguments provided by the signal.
+
+    See [RBXScriptSignal:Wait]
+]=]
+function BindableEventWrapper.Wait(self: BindableEventWrapper): ...any
+	return self._inner.Event:Wait()
+end
+
+return BindableEventWrapper