Skip to main content

Ser

Library for serializing and deserializing data.

See the Classes property for information on extending the use of the Ser library to include other classes.

Properties​

Classes​

</>
Ser.Classes: table

A dictionary of classes along with a Serialize and Deserialize function. For instance, the default class added is the Option class, which looks like the following: 

Ser.Classes.Option = {
	Serialize = function(opt) return opt:Serialize() end;
	Deserialize = Option.Deserialize;
}

Add to this table in order to extend what classes are automatically serialized/deserialized.

The Ser library checks every object's ClassName field in both serialized and deserialized data in order to map it to the correct function within the Classes table.

Functions​

SerializeArgs​

</>
Ser.SerializeArgs(...: any) → args: table

Serializes the arguments and returns the serialized values in a table.

SerializeArgsAndUnpack​

</>
Ser.SerializeArgsAndUnpack(...: any) → args: ...any

Serializes the arguments and returns the serialized values.

DeserializeArgs​

</>
Ser.DeserializeArgs(...: any) → args: table

Deserializes the arguments and returns the deserialized values in a table.

DeserializeArgsAndUnpack​

</>
Ser.DeserializeArgsAndUnpack(...: any) → args: table

Deserializes the arguments and returns the deserialized values.

Serialize​

</>
Ser.Serialize(value: any) → any

Serializes the given value.

Deserialize​

</>
Ser.Deserialize(value: any) → any

Deserializes the given value.

UnpackArgs​

</>
Ser.UnpackArgs(value: any) → any

Unpacks the arguments returned by either SerializeArgs or DeserializeArgs.

Show raw api
{
    "functions": [
        {
            "name": "SerializeArgs",
            "desc": "Serializes the arguments and returns the serialized values in a table.",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "args: table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 85,
                "path": "modules/ser/init.luau"
            }
        },
        {
            "name": "SerializeArgsAndUnpack",
            "desc": "Serializes the arguments and returns the serialized values.",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "args: ...any"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 103,
                "path": "modules/ser/init.luau"
            }
        },
        {
            "name": "DeserializeArgs",
            "desc": "Deserializes the arguments and returns the deserialized values in a table.",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "args: table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 113,
                "path": "modules/ser/init.luau"
            }
        },
        {
            "name": "DeserializeArgsAndUnpack",
            "desc": "Deserializes the arguments and returns the deserialized values.",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "args: table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 131,
                "path": "modules/ser/init.luau"
            }
        },
        {
            "name": "Serialize",
            "desc": "Serializes the given value.",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 141,
                "path": "modules/ser/init.luau"
            }
        },
        {
            "name": "Deserialize",
            "desc": "Deserializes the given value.",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 156,
                "path": "modules/ser/init.luau"
            }
        },
        {
            "name": "UnpackArgs",
            "desc": "Unpacks the arguments returned by either `SerializeArgs` or `DeserializeArgs`.",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 171,
                "path": "modules/ser/init.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Classes",
            "desc": "A dictionary of classes along with a Serialize and Deserialize function.\nFor instance, the default class added is the Option class, which looks\nlike the following:\n\n```lua\nSer.Classes.Option = {\n\tSerialize = function(opt) return opt:Serialize() end;\n\tDeserialize = Option.Deserialize;\n}\n```\n\nAdd to this table in order to extend what classes are automatically\nserialized/deserialized.\n\nThe Ser library checks every object's `ClassName` field in both serialized\nand deserialized data in order to map it to the correct function within\nthe Classes table.",
            "lua_type": "table",
            "source": {
                "line": 71,
                "path": "modules/ser/init.luau"
            }
        }
    ],
    "types": [],
    "name": "Ser",
    "desc": "Library for serializing and deserializing data.\n\nSee the `Classes` property for information on extending the use\nof the Ser library to include other classes.",
    "source": {
        "line": 47,
        "path": "modules/ser/init.luau"
    }
}