All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Added a toggle to avoid double destruction of instances.
- Fixed an error being thrown when an ended thread is cleaned up. (#31)
- Changed how threads are cleaned up internally.
Janitor.new
actually returns the typed Janitor class.
- Added
Janitor:GetAll
as requested by AlreadyPro.
- Fixed incorrect type in the Janitor exported type.
- Fixed out of date documentation in
Installation.md
.
- Removed the old toml files for Selene.
- Removed
foreman.toml
.
- Added
Janitor:RemoveNoClean
andJanitor:RemoveListNoClean
, which allows removal without cleaning. - Added a nicer type return for Janitor. No more
typeof(Janitor.new())
!
- Fixed serious issue where
Janitor:RemoveList
would not actually remove anything from the indices reference.
- Fixed Janitor error when attempting call task.cancel on a running thread
- Added a new
LinkToInstance
method which will instead useInstance.Destroying
. - Added traceback to
Janitor:AddPromise
for invalid promises.
- The legacy
LinkToInstance
method has been renamed toLegacyLinkToInstance
.
- Fixed Janitor not warning about an invalid
MethodName
for threads and functions. - Fixed incorrect documentation about
Janitor.CurrentlyCleaning
.
- You can now add a
thread
using:Add
. This will cancel said thread when the Janitor is cleaned up. - Added
__tostring
to the Janitor class. - Added
:RemoveList
as an alternative to long:Remove
chains. - Added the properties of
Janitor
andRbxScriptConnection
to the documentation.
- Recompiled with L+ C Edition.
- Put
RbxScriptConnection
in a separate file. - Documentation now will split the code examples by language more obviously.
Janitor:Cleanup
now uses a while loop instead of a for loop when cleaning up. Fixed by @codesenseAye.
Janitor:AddPromise
now will handle cancellations properly.
- Finding Promise is now more aware for plugins. This way it won't load a Promise library inside of ReplicatedStorage.
- APIs that return Janitor like
Janitor::Remove
no longer explicitly state the return type. This seems to cause problems with typed Luau.
- A brand new documentation site.
- Janitor's
__index
no longer points to a separate table.
- Urgent fix for the cleanup loop. I had forgotten the
continue
so it would've likely broken.
- This version has been scrubbed from GitHub releases for a reason.
- Added support for Promise existing in the
Server*
services. - Documentation comments have been overhauled.
- A singular version of Janitor is now the only version. This still supports Promises, it just searches for the Promise library.
- The file tree for Janitor has been standardized.
- The cleanup loop now uses
in pairs
instead ofin next
.
- The
task.spawn
cleanups are now removed.
- Janitor now cleans up the tasks using
task.spawn
. - Janitor now has types.
- Janitor will work far better with typed Luau as well.
Janitor:LinkToInstance
now works on deferred event mode. Shoutout to @Elttob for fixing it.
- Initial release.