@rbxts/flamework-meta-utils NPM

@rbxts/flamework-meta-utils

Metadata utility and utility macros for Flamework

Macros

deunify<T>()

Deunifies a union type T into an array of all constituents

const constituents = deunify<"a", "b", "c">();

Compiles to

local constituents = deunify({"a", "b", "c"}) -- which returns the passed param;

repeatString<S, N>()

Repeats the string S N times.

const line = repeatString<"-", 30>();

Compiles to

local line = "------------------------------";

getChildrenOfType<T>()

Generates a type guard (if one is not specified) and returns all children of the given instance that pass the guard.

interface CharacterModel extends Model {
  Humanoid: Humanoid;
  HumanoidRootPart: Part;
}

const characters = getChildrenOfType<CharacterModel>(Workspace.Characters);

getDescendantsOfType<T>()

Generates a type guard (if one is not specified) and returns all descendants of the given instance that pass the guard.

const assetsToPreload = getDescendantsOfType<Decal | Texture | MeshPart>(ReplicatedStorage);

getInstanceAtPath()

Resolves the instance at the given path using Rojo

const mouseControllerModule = getInstanceAtPath("src/client/controllers/mouse.ts");

safeCast<T>()

Generates a type guard (if one is not specified) and if the guard passes, returns the casted value. Otherwise returns undefined.

const value = safeCast<number>(someUnknownValue);
if (value !== undefined)
  print("doubled value:", value * 2)

interface CharacterModel extends Model {
  Humanoid: Humanoid;
  HumanoidRootPart: Part;
}

const character = safeCast<CharacterModel>(Players.LocalPlayer.Character);
if (character !== undefined)
  print("character root:", character.HumanoidRootPart)