Appearance
K.Guard
Functions
K.Guard.String
lua
K.Guard.String(options: { Min: number?, Max: number?, Pattern: string? }?): ValidatorK.Guard.Number
lua
K.Guard.Number(options: { Min: number?, Max: number? }?): ValidatorK.Guard.Integer
lua
K.Guard.Integer(options: { Min: number?, Max: number? }?): ValidatorK.Guard.Boolean
lua
K.Guard.Boolean(): ValidatorK.Guard.Vector3
lua
K.Guard.Vector3(options: { MaxMagnitude: number? }?): ValidatorK.Guard.CFrame
lua
K.Guard.CFrame(): ValidatorK.Guard.Instance
lua
K.Guard.Instance(className: string?): ValidatorAny object, or only objects of className (e.g. "BasePart").
K.Guard.Player
lua
K.Guard.Player(): ValidatorA player who is currently in the game.
K.Guard.OneOf
lua
K.Guard.OneOf(values: { any }): ValidatorOnly one of the listed values, e.g. K.Guard.OneOf({ "Red", "Blue" }).
K.Guard.Optional
lua
K.Guard.Optional(validator: Validator): ValidatorK.Guard.Any
lua
K.Guard.Any(): ValidatorA basic safety check for any value: finite numbers, valid text, small tables.
K.Guard.resolve
lua
K.Guard.resolve(spec: any, functionName: string): ValidatorTurns a type name like "string?" (or a validator function) into a validator.
K.Guard.Array
lua
K.Guard.Array(item: any, options: { Max: number? }?): ValidatorA list where every item passes item, e.g. K.Guard.Array("string", { Max = 10 }).
K.Guard.Shape
lua
K.Guard.Shape(fields: { [string]: any }): ValidatorA table with exactly these fields, e.g. K.Guard.Shape({ Name = "string", Amount = "integer" }).
K.Guard.compile
lua
K.Guard.compile(schema: { any }, functionName: string): { Validator }Turns a list like { "string", "number?" } into validators.
K.Guard.checkArguments
lua
K.Guard.checkArguments(validators: { Validator }?, args: { n: number, [number]: any }): (boolean, string?)Checks arguments from table.pack(...). Without validators, runs the basic safety check.
Generated from
src/Corode/Util/Guard.luau.
