Skip to content

K.Guard ​

Functions ​

K.Guard.String ​

lua
K.Guard.String(options: { Min: number?, Max: number?, Pattern: string? }?): Validator

K.Guard.Number ​

lua
K.Guard.Number(options: { Min: number?, Max: number? }?): Validator

K.Guard.Integer ​

lua
K.Guard.Integer(options: { Min: number?, Max: number? }?): Validator

K.Guard.Boolean ​

lua
K.Guard.Boolean(): Validator

K.Guard.Vector3 ​

lua
K.Guard.Vector3(options: { MaxMagnitude: number? }?): Validator

K.Guard.CFrame ​

lua
K.Guard.CFrame(): Validator

K.Guard.Instance ​

lua
K.Guard.Instance(className: string?): Validator

Any object, or only objects of className (e.g. "BasePart").

K.Guard.Player ​

lua
K.Guard.Player(): Validator

A player who is currently in the game.

K.Guard.OneOf ​

lua
K.Guard.OneOf(values: { any }): Validator

Only one of the listed values, e.g. K.Guard.OneOf({ "Red", "Blue" }).

K.Guard.Optional ​

lua
K.Guard.Optional(validator: Validator): Validator

K.Guard.Any ​

lua
K.Guard.Any(): Validator

A basic safety check for any value: finite numbers, valid text, small tables.

K.Guard.resolve ​

lua
K.Guard.resolve(spec: any, functionName: string): Validator

Turns a type name like "string?" (or a validator function) into a validator.

K.Guard.Array ​

lua
K.Guard.Array(item: any, options: { Max: number? }?): Validator

A list where every item passes item, e.g. K.Guard.Array("string", { Max = 10 }).

K.Guard.Shape ​

lua
K.Guard.Shape(fields: { [string]: any }): Validator

A 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.

Corode 0.13.0 · MIT License