Skip to main content

Types

Type definitions and QR spec constants.

Types​

ErrorCorrectionLevel​

</>
interface ErrorCorrectionLevel {
ordinal: number
formatBits: number
}

Mode​

</>
interface Mode {
modeBits: number
numBitsCharCount: {number}
}

QrSegmentData​

</>
interface QrSegmentData {
mode: Mode
numChars: number
bitData: {number}
}

QrCodeData​

</>
interface QrCodeData {
version: number
size: number
errorCorrectionLevel: ErrorCorrectionLevel
mask: number
modules: {{boolean}}
}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "ErrorCorrectionLevel",
            "desc": "",
            "fields": [
                {
                    "name": "ordinal",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "formatBits",
                    "lua_type": "number",
                    "desc": ""
                }
            ],
            "source": {
                "line": 14,
                "path": "src/types.luau"
            }
        },
        {
            "name": "Mode",
            "desc": "",
            "fields": [
                {
                    "name": "modeBits",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "numBitsCharCount",
                    "lua_type": "{ number }",
                    "desc": ""
                }
            ],
            "source": {
                "line": 25,
                "path": "src/types.luau"
            }
        },
        {
            "name": "QrSegmentData",
            "desc": "",
            "fields": [
                {
                    "name": "mode",
                    "lua_type": "Mode",
                    "desc": ""
                },
                {
                    "name": "numChars",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "bitData",
                    "lua_type": "{ number }",
                    "desc": ""
                }
            ],
            "source": {
                "line": 37,
                "path": "src/types.luau"
            }
        },
        {
            "name": "QrCodeData",
            "desc": "",
            "fields": [
                {
                    "name": "version",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "size",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "errorCorrectionLevel",
                    "lua_type": "ErrorCorrectionLevel",
                    "desc": ""
                },
                {
                    "name": "mask",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "modules",
                    "lua_type": "{ { boolean } }",
                    "desc": ""
                }
            ],
            "source": {
                "line": 52,
                "path": "src/types.luau"
            }
        }
    ],
    "name": "Types",
    "desc": "Type definitions and QR spec constants.",
    "source": {
        "line": 7,
        "path": "src/types.luau"
    }
}