JSPM

@rbxts/flamework-meta-utils

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 383
  • Score
    100M100P100Q90754F
  • License ISC

Metadata utility for Flamework

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rbxts/flamework-meta-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    @rbxts/flamework-meta-utils

    Metadata utility for Flamework

    Methods

    getInstanceAtPath()

    Resolves the instance at the given path using Rojo

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

    safeCast<T>()

    Macro that 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)
    const character = safeCast<CharacterModel>(Players.LocalPlayer.Character);
    if (character !== undefined)
      print("character root:", character.HumanoidRootPart)

    resolveDependencies()

    Takes a constructor and resolves it and all of it's dependencies

    processDependencies()

    Calls the provided method for each dependency resolved from the provided constructor

    callMethodOnDependencies()

    Calls the method from the provided method descriptor for each dependency resolved from the provided constructor