Skip to main content

Types

Types​

GenericFilter​

</>
type GenericFilter = <T>(object: T) → any?

A generic filter function that takes an object of type T and returns a boolean value indicating whether or not the object should be included in the result.

Property​

</>
interface Property {
MemberType: "Property"
Category: string
Name: string
Security: {
Read: string,
Write: string
}
Serialization: {
CanLoad: boolean,
CanSave: boolean
}
Tags: {string}?
ThreadSafety: string
ValueType: {
Category: string,
Name: string
}
}

Function​

</>
interface Function {
MemberType: "Function"
Name: string
Parameters: {{
Name: string,
Type: string,
Default: string?
}}
ReturnType: {
Category: string,
Name: string
}
Security: string
Tags: {string}?
ThreadSafety: string
}

Event​

</>
interface Event {
MemberType: "Event"
Name: string
Parameters: {{
Name: string,
Type: string
}}
Security: string
Tags: {string}?
ThreadSafety: string
}

Callback​

</>
interface Callback {
MemberType: "Callback"
Name: string
Parameters: {{
Name: string,
Type: string
}}
ReturnType: {
Category: string,
Name: string
}
Security: string
Tags: {string}?
ThreadSafety: string
}

APIDump​

</>
type APIDump = {
Classes: {[any]: any},
[string]: any
}

An API dump is a table that contains the raw Roblox API dump data. As a minimum, the Dump expects an APIDump to contain a Classes array.

Member​

</>
type Member = Property | Function | Event | Callback

Class​

</>
interface Class {
Members: {Member}
MemoryCategory: string
Name: string
Superclass: string
Tags: {string}?
}

ClassWithInheritance​

</>
type ClassWithInheritance = Class&{Inherits: {string}}

Item​

</>
type Item = Member | Class
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "GenericFilter",
            "desc": "A generic filter function that takes an object of type T and\nreturns a boolean value indicating whether or not the object\nshould be included in the result.",
            "lua_type": "<T>(object: T) -> any?",
            "source": {
                "line": 14,
                "path": "src/init.d.lua"
            }
        },
        {
            "name": "Property",
            "desc": "",
            "fields": [
                {
                    "name": "MemberType",
                    "lua_type": "\"Property\"",
                    "desc": ""
                },
                {
                    "name": "Category",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Security",
                    "lua_type": "{ Read: string, Write: string }",
                    "desc": ""
                },
                {
                    "name": "Serialization",
                    "lua_type": "{ CanLoad: boolean, CanSave: boolean }",
                    "desc": ""
                },
                {
                    "name": "Tags",
                    "lua_type": "{ string }?",
                    "desc": ""
                },
                {
                    "name": "ThreadSafety",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "ValueType",
                    "lua_type": "{ Category: string, Name: string }",
                    "desc": ""
                }
            ],
            "source": {
                "line": 28,
                "path": "src/init.d.lua"
            }
        },
        {
            "name": "Function",
            "desc": "",
            "fields": [
                {
                    "name": "MemberType",
                    "lua_type": "\"Function\"",
                    "desc": ""
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Parameters",
                    "lua_type": "{{ Name: string, Type: string, Default: string? }}",
                    "desc": ""
                },
                {
                    "name": "ReturnType",
                    "lua_type": "{ Category: string, Name: string }",
                    "desc": ""
                },
                {
                    "name": "Security",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Tags",
                    "lua_type": "{ string }?",
                    "desc": ""
                },
                {
                    "name": "ThreadSafety",
                    "lua_type": "string",
                    "desc": ""
                }
            ],
            "source": {
                "line": 59,
                "path": "src/init.d.lua"
            }
        },
        {
            "name": "Event",
            "desc": "",
            "fields": [
                {
                    "name": "MemberType",
                    "lua_type": "\"Event\"",
                    "desc": ""
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Parameters",
                    "lua_type": "{{ Name: string, Type: string }}",
                    "desc": ""
                },
                {
                    "name": "Security",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Tags",
                    "lua_type": "{ string }?",
                    "desc": ""
                },
                {
                    "name": "ThreadSafety",
                    "lua_type": "string",
                    "desc": ""
                }
            ],
            "source": {
                "line": 79,
                "path": "src/init.d.lua"
            }
        },
        {
            "name": "Callback",
            "desc": "",
            "fields": [
                {
                    "name": "MemberType",
                    "lua_type": "\"Callback\"",
                    "desc": ""
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Parameters",
                    "lua_type": "{{ Name: string, Type: string }}",
                    "desc": ""
                },
                {
                    "name": "ReturnType",
                    "lua_type": "{ Category: string, Name: string }",
                    "desc": ""
                },
                {
                    "name": "Security",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Tags",
                    "lua_type": "{ string }?",
                    "desc": ""
                },
                {
                    "name": "ThreadSafety",
                    "lua_type": "string",
                    "desc": ""
                }
            ],
            "source": {
                "line": 99,
                "path": "src/init.d.lua"
            }
        },
        {
            "name": "APIDump",
            "desc": "An API dump is a table that contains the raw Roblox API dump\ndata. As a minimum, the Dump expects an APIDump to contain\na `Classes` array.",
            "lua_type": "{ Classes: { [any]: any }, [string]: any }",
            "source": {
                "line": 117,
                "path": "src/init.d.lua"
            }
        },
        {
            "name": "Member",
            "desc": "",
            "lua_type": "Property | Function | Event | Callback",
            "source": {
                "line": 126,
                "path": "src/init.d.lua"
            }
        },
        {
            "name": "Class",
            "desc": "",
            "fields": [
                {
                    "name": "Members",
                    "lua_type": "{ Member }",
                    "desc": ""
                },
                {
                    "name": "MemoryCategory",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Superclass",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Tags",
                    "lua_type": "{ string }?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 137,
                "path": "src/init.d.lua"
            }
        },
        {
            "name": "ClassWithInheritance",
            "desc": "",
            "lua_type": "Class & { Inherits: { string } }",
            "source": {
                "line": 149,
                "path": "src/init.d.lua"
            }
        },
        {
            "name": "Item",
            "desc": "",
            "lua_type": "Member | Class",
            "source": {
                "line": 157,
                "path": "src/init.d.lua"
            }
        }
    ],
    "name": "Types",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/init.d.lua"
    }
}