Bin

Bin is a module for the quick and easy cleanup of objects. As of writing this, it can clean up the following

• Instance
• RBXScriptConnection
• thread
• Table with function Destroy, CleanUp, Clean, Clear, or Disconnect

It introduces syntax sugar for certain objects, such as one mimicking a connection, so that you can shorthand queue it for being cleaned up, with methods such as Connect(ConnectionLike). This makes it trivial to cleanup the items you've created during a function, by centralizing the data into one place, and we call that, Bin.

More shapes and sizes are planned to be added for compatiblity with Bin. Bin will aim to support any shape of data that is commonly seen around Roblox.

Bin does plan to support custom cleanup methods being passed as args.

Types

Bin

The object returned by Bin.new()

type Function = (...any) -> ...any
type Listener = (Signal, Function) -> ConnectionLike
type ConnectionLike = {
	Connected: boolean,
	Disconnect: (any) -> (),
} | RBXScriptConnection

type Cleanable = {
	Destroy: (any) -> ()?,
	CleanUp: (any) -> ()?,
	Clean: (any) -> ()?,
	Clear: (any) -> ()?,
}

type Item = Instance | Cleanable | ConnectionLike | Function | thread

export type Bin = {
	_bin: { any },

	Add: <T>(Bin, Item & T) -> T,
	Remove: <T>(Bin, Item & T) -> T,
	Clear: (Bin) -> (),
	Connect: (Bin, Signal, Function) -> ConnectionLike,
}

Constructors

new

The primary constructor for creating a Bin object

local Bin = require(...)

local bin = Bin.new()

Methods

Add

Add an item to your bin, to be cleaned up when bin:Clear() is called. This function supports a wide array of instances, see the type for Bin to see what can and can't be cleaned up.

local Bin = require(...)

local bin = Bin.new()

local folder = Instance.new("Folder")
bin:Add(folder)

local thread = task.spawn(function() end)
bin:Add(thread)

Remove

Remove an item previously added to your bin via Add, when the bin is cleared via Clear, this item will not be cleaned up. Calling this method on an item which is not in the bin will do nothing.

local Bin = require(...)

local bin = Bin.new()

local folder = Instance.new("Folder")
folder.Parent = script

bin:Add(folder)
bin:Remove(folder)
bin:Clear()

print(folder.Parent) -- script

Clear

Clear items previously added to your bin.

local Bin = require(...)

local bin = Bin.new()

local folder = Instance.new("Folder")
bin:Add(folder)

local thread = task.spawn(function() end)
bin:Add(thread)

bin:Clear()

print(folder.Parent) -- nil
print(coroutine.status(thread)) -- dead

Connect

Shorthand for Add(connection: ConnectionLike)

local Bin = require(...)

local bin = Bin.new()

local function onScriptChanged()
end

bin:Connect(script.Changed, onScriptChanged)