Skip to main content

Brine

Fast and efficient extensible serialiation and deserialization library for Roblox with native instance support out of the box

Functions​

serialize​

</>
Brine.serialize(
data: Instance,
options: BrineTypes.BrineOptions?
) → (
BrineTypes.Brined,
BrineTypes.References?
)

Serializes an instance into a string, with optional references

deserialize​

</>
Brine.deserialize(
data: BrineTypes.Brined,
options: BrineTypes.BrineOptions?
) → Instance?

Deserializes a string into an instance, with optional references

observeSerialize​

</>
Brine.observeSerialize(
data: Instance,
options: BrineTypes.BrineOptions?
) → Observable.Observable<BrineTypes.EncodedBrinePacket>

Observes changes to an instance

observeDeserialize​

</>
Brine.observeDeserialize(
observableStream: Observable.Observable<BrineTypes.EncodedBrinePacket>,
options: BrineTypes.BrineOptions?
) → Observable.Observable<Instance>

Observes changes to an instance, returning deserialized instances

Show raw api
{
    "functions": [
        {
            "name": "serialize",
            "desc": "Serializes an instance into a string, with optional references",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "BrineTypes.BrineOptions?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BrineTypes.Brined"
                },
                {
                    "desc": "",
                    "lua_type": "BrineTypes.References?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 30,
                "path": "src/brine/src/Shared/Brine.lua"
            }
        },
        {
            "name": "deserialize",
            "desc": "Deserializes a string into an instance, with optional references",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "BrineTypes.Brined"
                },
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "BrineTypes.BrineOptions?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 40,
                "path": "src/brine/src/Shared/Brine.lua"
            }
        },
        {
            "name": "observeSerialize",
            "desc": "Observes changes to an instance",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "BrineTypes.BrineOptions?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<BrineTypes.EncodedBrinePacket>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 50,
                "path": "src/brine/src/Shared/Brine.lua"
            }
        },
        {
            "name": "observeDeserialize",
            "desc": "Observes changes to an instance, returning deserialized instances",
            "params": [
                {
                    "name": "observableStream",
                    "desc": "",
                    "lua_type": "Observable.Observable<BrineTypes.EncodedBrinePacket>"
                },
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "BrineTypes.BrineOptions?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<Instance>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 234,
                "path": "src/brine/src/Shared/Brine.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Brine",
    "desc": "Fast and efficient extensible serialiation and deserialization library for Roblox with native instance support out of the box",
    "source": {
        "line": 8,
        "path": "src/brine/src/Shared/Brine.lua"
    }
}