Class Factory

The module returns a callable table.

local Class = require("class")

`Class(definition)`

Creates a class from a definition table.

local Example = Class({
	init = function(self)
		self.ready = true
	end,
})

Equivalent to Class:new(definition).

Creates a class and prepares its metatable.

Field	Description
`init`	Optional constructor called for each instance.
`__type`	Optional readable type name. Defaults to `"Class"`.
`__includes`	Optional table, class, string, or list of includes.
methods	Any function fields become instance methods.

Field	Description
`__private`	Per-instance table for private state.
`__type`	Readable type copied from the class.
`__class`	Direct reference to the class table that created the instance.

Method	Description
`Is(expected)`	Returns whether the instance matches a class, parent class, or type name.
`AssertIs(expected, name)`	Raises an error when the instance does not match `expected`.
`DebugInfos()`	Returns formatted diagnostic information.

Returns true when value matches expected.

local Player = Class({
	__type = "Player",
})

local player = Player()

print(Class:is(player, Player))
print(player:Is(Player))

expected can be a class table or a string. Class-table checks are stricter and should be preferred for validation.

Validates a value and returns it when it matches the expected class.

player = Class:assertIs(player, Player, "player")

When validation fails, an error is raised with the expected and received type.

Creates a typed class from a prototype and optional parent.

local Registered = Class:registerClass("Registered", {
	hello = function()
		return "hello"
	end,
})

The returned class has __type set to name and operator helpers enabled. Prototype and parent tables are included and tracked for type checks.