npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rbxts/cleanser

v2.1.0

Published

A port of RobloxianDemo's Cleanser class.

Downloads

29

Readme

Cleanser

Cleanser is a highly personalized, all-in-one, and lightweight implementation served for garbage collection.

Installation

📦 — NPM:

npm i @rbxts/cleanser

🧶 — Yarn:

yarn add @rbxts/cleanser

📀 — pnPM:

pnpm add @rbxts/cleanser

Cleanser API

Types

interface Destroyable {
	TimedDestroy(waitTime: number): boolean;
	Cleanse(): void;
	Destroy(): void;
}

type Object =
	| never
	| undefined
	| ((this: defined) => void)
	| ((_: defined) => void)
	| ExtractKeys<defined, () => void>
	| thread
	| RBXScriptConnection
	| Cleanser
	| Cleanser.Destroyable;

Constructor

const cleanser = new Cleanser.Cleanser<{ Instances: Array<Instance> }>();

Cleanser.Is

public Is(
		object?: T extends Cleanser.Object | Cleanser.Destroyable | true ? RBXScriptConnection : T | defined,
	): boolean;

Returns whether or not the specified class is a valid Cleanser.

Cleanser.Grant

public Grant(object?: T extends Cleanser.Object | Cleanser.Destroyable | true ? RBXScriptConnection : T |   defined,
	): Cleanser;

Grant a new cleanser task.

Cleanser.TimedDestroy

public TimedDestroy(waitTime: number): boolean;

Destroy and cleanup a cleanser after a certain amount of time has elapsed.

Cleanser.Cleanse

public Cleanse(): void;

Cleanse the specified cleanser object(s).

Cleanser.Destroy

public Destroy(): void;

Destroy and cleanup a Cleanser (making it unusable).

Example

// Services
import { Workspace } from "@rbxts/services";

// Modules
import { Cleanser } from "@rbxts/cleanser";

// Functions
const Part = new Instance("Part");
Part.Name = "Part";
Part.Position = new Vector3(0, 5, 0);
Part.Size = new Vector3(5, 1, 5);
Part.Parent = Workspace;

const PartCleanser = new Cleanser.Cleanser(Part);
task.wait(3);
PartCleanser.Cleanse();