chore(docs): update supported types

This commit is contained in:
khtsly 2026-04-09 01:01:26 +07:00
parent 33477c4b74
commit 39143db390

View file

@ -19,10 +19,9 @@ Define strict data schemas for optimized serialization and type safety.
-- Basic types -- Basic types
"boolean", "boolean",
"string", "string",
"nil",
-- Numeric types -- Numeric types
"u8", -- usigned-int "u8", -- unsigned-int
"u16", "u16",
"u32", "u32",
"i8", -- signed-int "i8", -- signed-int
@ -33,12 +32,26 @@ Define strict data schemas for optimized serialization and type safety.
"f64", "f64",
-- Roblox types -- Roblox types
"buffer" "buffer",
"vector2", -- f16 "vector2", -- f16 x/y
"vector3", -- f16 "vector3", -- f16 x/y/z
"cframe", -- f32 & f16 "vector2int16", -- i16 x/y
"color3", -- u8 "vector3int16", -- i16 x/y/z
"cframe", -- f32 position + compressed rotation (f16)
"color3", -- u8 r/g/b
"color3f16", "color3f16",
"udim",
"udim2",
"rect",
"ray",
"numberrange",
"colorsequence",
"numbersequence",
"brickcolor",
"tweeninfo",
"physicalproperties",
"font",
"datetime",
"instance", "instance",
-- other types -- other types
@ -49,6 +62,10 @@ Define strict data schemas for optimized serialization and type safety.
} }
``` ```
::: info
there is no standalone `"nil"` schema type. To represent a value that can be `nil`, wrap it with `"optional"` (e.g. `Buffer.Schema.optional(Buffer.Schema.u16)`).
:::
## Custom Datatypes ## Custom Datatypes
### `.custom_datatype` ### `.custom_datatype`