general improvements, added childrenof and descendantsof type functions

Author: cameronpcampbell

.github/workflows/release.yml

@@ -100,6 +100,7 @@ jobs:
         run: |
           export PATH="$HOME/.rokit/bin:$PATH"
           rokit trust UpliftGames/wally
+          rokit trust rojo-rbx/rojo
           rokit install
 
       - name: Rokit Cache Save

.gitignore

@@ -5,6 +5,8 @@
 /*.rbxlx.lock
 /*.rbxl.lock
 
+sourcemap.json
+
 # MacOS file system clutter.
 ._*
 .DS_STORE

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.0.2
+# Features
+- Added `ChildrenOf` and `DescendantsOf` type functions.
+
 # v0.0.1
 # Features
 - Initital release.

README.md

@@ -1,20 +1,21 @@
 # Typebrick
 A Type Function utility library for Roblox.
 
+wally: https://wally.run/package/cameronpcampbell/typebrick
+
 > [!TIP]
 > Check out [Typeforge](https://github.com/typeforge-luau/typeforge), a type function utility library for Luau.
 
-wally: https://wally.run/package/cameronpcampbell/typebrick
-
 ## Docs
 
 ### PropertiesOf(input: type) -> type
 Returns a table of properties for the given Roblox instance.
 
 ```luau
-type Props = PropertiesOf<Part>
+type Result = PropertiesOf<Part>
+
 --[[
-{
+type Result = {
     Anchored: boolean,
     ... *TRUNCATED*
 ]]
@@ -24,9 +25,10 @@ type Props = PropertiesOf<Part>
 Returns a table of methods for the given Roblox instance.
 
 ```luau
-type Methods = MethodsOf<Part>
+type Result = MethodsOf<Part>
+
 --[[
-{
+type Result = {
     AddTag: (Instance, string) -> nil,
     ... *TRUNCATED*
 ]]
@@ -36,9 +38,10 @@ type Methods = MethodsOf<Part>
 Returns a table of events for the given Roblox instance.
 
 ```luau
-type Events = EventsOf<Part>
+type Result = EventsOf<Part>
+
 --[[
-{
+type Result = {
     AncestryChanged: {
         Connect: t1,
         ConnectParallel: (t2, (Instance, Instance?) -> ()) -> RBXScriptConnection,
@@ -47,4 +50,33 @@ type Events = EventsOf<Part>
     },
     ... *TRUNCATED*
 ]]
+```
+
+### ChildrenOf(input: type) -> type
+Returns a table of children for the given Roblox instance.
+
+```luau
+type Result = ChildrenOf<typeof(workspace.Part)>
+
+--[[
+type Result = {
+    1: Attachment
+}
+]]
+```
+
+### DescendantsOf(input: type) -> type
+Returns a table of children for the given Roblox instance.
+
+```luau
+type Result = DescendantsOf<typeof(workspace)>
+
+--[[
+type Result = {
+    1: Part,
+    2: Camera,
+    3: Terrain,
+    4: Attachment
+}
+]]
 ```

rokit.toml

@@ -5,3 +5,4 @@
 
 [tools]
 wally = "UpliftGames/wally@0.3.2"
+rojo = "rojo-rbx/rojo@7.6.1"