ClassNameTypePairs

Useful for adding Types to Functions & Type Functions, inspired by Vide!

(exact inspiration source)

The module version shall always be whichever it was here at the time this API-Dump was accessed and used to generate this module.

Initial philosophy

See clarification below

This module shall NEVER have anything functional except

• A return value const ClassNameTypePairs = table.freeze({})
• Type definition "ClassNameTypePairs" export type ClassNameTypePairs = {
• Return of the return value return ClassNameTypePairs
• a nil return (return nil) at the end

ONLY the contents of the "ClassNameTypePairs" type definition shall be ever changed.

This is required to allow for safe usage of ANY version of this module (@*).

To achieve SemVer (i.e. Zer0Ver in this case), the Major Version part will be removed if 0, otherwise amplified:

This is required to perform wally publish

e.g. 0.736.0.7361342 -> 736.0.7361342

if Major Version ever becomes > 0, concat its value * 1000 at the beginning, e.g. 1.736.0.7361342 -> 1000736.0.7361342

More info on Version here

Actual philosophy

The initial version was using api version of 0.736.0.7361342

The next release uses 0.736.0.7361346 and inroduces the following:

The contents of src/init.luau are automatically generated from the (special thanks to) Roblox API Dump (the Roblox-Client-Tracker by MaximumADHD) and must not be manually edited.

as of 0.736.0.7361346 release, the auto-generation script is not yet open-soruced, but is planned or will be likely converted into a GitHub actions action

That also means that this module only guarantees backwards-compatibility for three type definitions, of which one was already guaranteed initially.

• ClassNameTypePairs

ALL CLASS NAMES (as intended initially)

• ClassNameTypePairsLeaf

represents ALL CLASS NAMES that have no children, thus each of them is a leaf

• ClassNameTypePairsChild

represents ALL CLASS NAMES that are roots (in other words child classes of the roblox studio hierarchy, this is just Object, but the auto-generator will add (detect) more if roblox ever makes such update)

these type definitions are guaranteed to be present, regardless of the module version, starting now (v0.736.0.7361346 release), however their contents are not going to be consistent, or are, but only as much as Roblox allows them to.

When Roblox removes a ClassName (e.g. it was deprecated and removed), that ClassName will no longer be included in releases of this module, except in the lower versions of the module, that've captured them before!

---

Available Here!

• This repository ~ src/init.luau

• Wally

  ClassNameTypePairs = "coffilhg/classnametypepairs@*"

• Rotriever

  ClassNameTypePairs = "github.com/Coffilhg/Useful-Modules@0.736.0.7361346"

---

Dependencies

• None

---

License & Attribution

This module is licensed under the Unlicense License.

See here or here to learn more

Stars are appreciated!