Skip to main content

validation

Namespace containing internal validation utilities and scope tracking.

Properties​

scopesEnabled​

</>
validation.scopesEnabled: boolean

The VALIDATIONENABLED setting.

Functions​

assertSchemaType​

</>
validation.assertSchemaType(
v: any,--

Value to check.

t: string,--

Expected type.

parameter: string | number,--

Parameter index or a string override for it.

context: string?--

Calling function. defaults to Squish.{funcname}.

) → ()

Used for validating schema types when constructing SerDes.

assertIsSerdes​

</>
validation.assertIsSerdes(
v: any,--

Value to check if is serdes.

parameter: string | number,--

Parameter index or a string override for it.

context: string?--

Calling function. defaults to Squish.{funcname}.

) → ()

Asserts whether the provided value is a valid SerDes.

assertSerdesType​

</>
validation.assertSerdesType(
serdes: SerDes<any>,--

Serdes to check.

t: string,--

Expected type of serdes.

parameter: string | number,--

Parameter index or a string override for it.

context: string?--

Calling function. defaults to Squish.{funcname}.

) → ()

Asserts whether the provided SerDes matches the expected type.

assertSerializeType​

</>
validation.assertSerializeType(
cursor: Cursor,
value: any,
type: string
) → ()

Asserts that the value being serialized matches the expected type.

beginValidationScope​

</>
validation.beginValidationScope(
cursor: Cursor,
name: string
) → ()

Appends name to the validation scopes.

exitValidationScope​

</>
validation.exitValidationScope(cursor: Cursor) → ()

Pops the current validation scope.

overrideValidationScopeName​

</>
validation.overrideValidationScopeName(
cursor: Cursor,
name: string
) → ()

Changes the name of the last validation scope.

Show raw api
{
    "functions": [
        {
            "name": "assertSchemaType",
            "desc": "Used for validating schema types when constructing SerDes.",
            "params": [
                {
                    "name": "v",
                    "desc": "Value to check.",
                    "lua_type": "any"
                },
                {
                    "name": "t",
                    "desc": "Expected type.",
                    "lua_type": "string"
                },
                {
                    "name": "parameter",
                    "desc": "Parameter index or a string override for it.",
                    "lua_type": "string | number"
                },
                {
                    "name": "context",
                    "desc": "Calling function. defaults to `Squish.{funcname}`.",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 48,
                "path": "src/moonwave.luau"
            }
        },
        {
            "name": "assertIsSerdes",
            "desc": "Asserts whether the provided value is a valid SerDes.",
            "params": [
                {
                    "name": "v",
                    "desc": "Value to check if is serdes.",
                    "lua_type": "any"
                },
                {
                    "name": "parameter",
                    "desc": "Parameter index or a string override for it.",
                    "lua_type": "string | number"
                },
                {
                    "name": "context",
                    "desc": "Calling function. defaults to `Squish.{funcname}`.",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/moonwave.luau"
            }
        },
        {
            "name": "assertSerdesType",
            "desc": "Asserts whether the provided SerDes matches the expected type.",
            "params": [
                {
                    "name": "serdes",
                    "desc": "Serdes to check.",
                    "lua_type": "SerDes<any>"
                },
                {
                    "name": "t",
                    "desc": "Expected type of serdes.",
                    "lua_type": "string"
                },
                {
                    "name": "parameter",
                    "desc": "Parameter index or a string override for it.",
                    "lua_type": "string | number"
                },
                {
                    "name": "context",
                    "desc": "Calling function. defaults to `Squish.{funcname}`.",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 63,
                "path": "src/moonwave.luau"
            }
        },
        {
            "name": "assertSerializeType",
            "desc": "Asserts that the value being serialized matches the expected type.",
            "params": [
                {
                    "name": "cursor",
                    "desc": "",
                    "lua_type": "Cursor"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "type",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 70,
                "path": "src/moonwave.luau"
            }
        },
        {
            "name": "beginValidationScope",
            "desc": "Appends `name` to the validation scopes.",
            "params": [
                {
                    "name": "cursor",
                    "desc": "",
                    "lua_type": "Cursor"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 76,
                "path": "src/moonwave.luau"
            }
        },
        {
            "name": "exitValidationScope",
            "desc": "Pops the current validation scope.",
            "params": [
                {
                    "name": "cursor",
                    "desc": "",
                    "lua_type": "Cursor"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 81,
                "path": "src/moonwave.luau"
            }
        },
        {
            "name": "overrideValidationScopeName",
            "desc": "Changes the name of the last validation scope.",
            "params": [
                {
                    "name": "cursor",
                    "desc": "",
                    "lua_type": "Cursor"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 87,
                "path": "src/moonwave.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "scopesEnabled",
            "desc": "The `VALIDATIONENABLED` setting.",
            "lua_type": "boolean",
            "source": {
                "line": 40,
                "path": "src/moonwave.luau"
            }
        }
    ],
    "types": [],
    "name": "validation",
    "desc": "Namespace containing internal validation utilities and scope tracking.",
    "source": {
        "line": 36,
        "path": "src/moonwave.luau"
    }
}