UgCore.Schema

Shared Runs in your resource. See the Schemas guide for patterns. Every rule is bounded. Validated input has a known maximum size.

Builders

Builder	Options	Notes
`String(opts)`	`max` required, `min`, `pattern`, `multiline`, `validate`	Counts UTF-8 characters. Rejects invalid UTF-8 and control characters.
`Number(opts?)`	`min`, `max`, `validate`	Rejects NaN and infinity.
`Integer(opts?)`	`min`, `max`, `validate`	Normalizes `5.0` to `5`.
`Boolean(opts?)`	`validate`
`Vector2/3/4(opts?)`	`maxComponent`, `validate`	Checks the native vector type and finite components.
`Enum(values, opts?)`	`validate`	Values are strings, numbers or booleans.
`Array(item, opts)`	`max` required, `min`, `validate`	Rejects holes and non-integer keys.
`Map(key, value, opts)`	`max` required, `min`, `validate`	Keys: `String`, `Integer`, `Number`, `Enum` or `Boolean`.
`Object(fields, opts?)`	`strict` (default `true`), `validate`	Strict rejects unknown keys. Non-strict drops them.
`Optional(rule)`		Allows `nil`. Not allowed inside `Array` or `Map`.

validate is fun(value): boolean, string?. It runs after the built-in checks inside pcall.

Unknown options raise with a suggestion. String, Array and Map without max raise at load time.

Define

UgCore.Schema.Define(rules) -> schema

UgSchemaRule[]

required

One rule per argument. Optional rules MUST be trailing.

Validate

UgCore.Schema.Validate(schema, ...) -> ok, args, detail

boolean

table?

Fresh values with n set to the declared count. Use table.unpack(args, 1, args.n).

string?

Failure path, such as arg 1.items[2].name: MUST be a string. For server logs only.

Trailing nils are tolerated. Extra values are rejected.

Check

UgCore.Schema.Check(rule, value) -> ok, value, detail

Validates one value against one rule.

Example

local S = UgCore.Schema

local schema = S.Define({
    S.String({ min = 1, max = 32, pattern = '^[%w_]+$' }),
    S.Array(S.Object({
        item = S.String({ max = 64 }),
        count = S.Integer({ min = 1, max = 100 }),
    }), { max = 20 }),
    S.Optional(S.Boolean()),
})

local ok, args, detail = S.Validate(schema, 'shop_1', { { item = 'water', count = 2 } })

Overview

Core

Networking and security

Modules

Reference

Builders

Define

Validate

Check

Example

​Builders

​Define

​Validate

​Check

​Example

Builders

Define

Validate

Check

Example