Skip to main content

Record

Represents the occurrence of an event.

Types

RecordMessage

</>
type RecordMessage = string

An object that represents a record's message. At the moment, this may only be a string.

timestamp

</>
type timestamp = number

Seconds since the Unix epoch under UTC time.

Properties

logger

since 0.1.0
</>
Record.logger: Logger

The logger which created this record.

level

since 0.1.0
</>
Record.level: Level

The level representing the importance or severity of the event the record represents.

message

since 0.2.0
</>
Record.message: RecordMessage

The record's message.

created

since 0.1.0
</>
Record.created: timestamp

The time when the record was created.

handled

since 0.1.0
</>
Record.handled: boolean

Whether this record has been handled by at least one Handler.

Functions

getMessage

since 0.1.0
</>
Record:getMessage() → string

Returns the formatted message.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Create a new record for the given [Logger] with the importance/severity indicated by [Level].\nThe provided values are formatted to generate the record message ([Record:getMessage]).\nThis should not be called directly. Instead, use [Logger:log] and its variants.",
            "params": [
                {
                    "name": "logger",
                    "desc": "",
                    "lua_type": "Logger"
                },
                {
                    "name": "level",
                    "desc": "",
                    "lua_type": "Level"
                },
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "RecordMessage"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Record"
                }
            ],
            "function_type": "static",
            "since": "0.1.0",
            "private": true,
            "source": {
                "line": 67,
                "path": "Logging/Record.lua"
            }
        },
        {
            "name": "getMessage",
            "desc": "Returns the formatted message.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "since": "0.1.0",
            "source": {
                "line": 89,
                "path": "Logging/Record.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "logger",
            "desc": "The logger which created this record.",
            "lua_type": "Logger",
            "since": "0.1.0",
            "source": {
                "line": 14,
                "path": "Logging/Record.lua"
            }
        },
        {
            "name": "level",
            "desc": "The level representing the importance or severity of the event the record represents.",
            "lua_type": "Level",
            "since": "0.1.0",
            "source": {
                "line": 21,
                "path": "Logging/Record.lua"
            }
        },
        {
            "name": "message",
            "desc": "The record's message.",
            "lua_type": "RecordMessage",
            "since": "0.2.0",
            "source": {
                "line": 34,
                "path": "Logging/Record.lua"
            }
        },
        {
            "name": "created",
            "desc": "The time when the record was created.",
            "lua_type": "timestamp",
            "since": "0.1.0",
            "source": {
                "line": 47,
                "path": "Logging/Record.lua"
            }
        },
        {
            "name": "handled",
            "desc": "Whether this record has been handled by at least one [Handler].",
            "lua_type": "boolean",
            "since": "0.1.0",
            "source": {
                "line": 54,
                "path": "Logging/Record.lua"
            }
        }
    ],
    "types": [
        {
            "name": "RecordMessage",
            "desc": "An object that represents a record's message. At the moment, this may only be a string.",
            "lua_type": "string",
            "source": {
                "line": 27,
                "path": "Logging/Record.lua"
            }
        },
        {
            "name": "timestamp",
            "desc": "Seconds since the Unix epoch under UTC time.",
            "lua_type": "number",
            "source": {
                "line": 40,
                "path": "Logging/Record.lua"
            }
        }
    ],
    "name": "Record",
    "desc": "Represents the occurrence of an event.",
    "source": {
        "line": 5,
        "path": "Logging/Record.lua"
    }
}