Class LogRecord

An object that encapsulates provided message and arguments as well some metadata that can be later used when formatting a message.

import { LogRecord } from "@std/log/logger";
import { LogLevels } from "@std/log/levels";
import { assertEquals } from "@std/assert/equals";

const record = new LogRecord({
msg: "Hello, world!",
args: ["foo", "bar"],
level: LogLevels.INFO,
loggerName: "example",
});

assertEquals(record.msg, "Hello, world!");
assertEquals(record.args, ["foo", "bar"]);
assertEquals(record.level, LogLevels.INFO);
assertEquals(record.loggerName, "example");

Constructors

Properties

Accessors

Constructors

  • Constructs a new instance.

    Parameters

    Returns LogRecord

    import { LogRecord } from "@std/log/logger";
    import { LogLevels } from "@std/log/levels";

    const record = new LogRecord({
    msg: "Hello, world!",
    args: ["foo", "bar"],
    level: LogLevels.INFO,
    loggerName: "example",
    });

Properties

level: number

The numeric log level of the log record.

import { LogRecord } from "@std/log/logger";
import { LogLevels } from "@std/log/levels";
import { assertEquals } from "@std/assert/equals";

const record = new LogRecord({
msg: "Hello, world!",
args: ["foo", "bar"],
level: LogLevels.INFO,
loggerName: "example",
});

assertEquals(record.level, LogLevels.INFO);
levelName: string

The name of the log level of the log record.

import { LogRecord } from "@std/log/logger";
import { LogLevels } from "@std/log/levels";
import { assertEquals } from "@std/assert/equals";

const record = new LogRecord({
msg: "Hello, world!",
args: ["foo", "bar"],
level: LogLevels.INFO,
loggerName: "example",
});

assertEquals(record.levelName, "INFO");
loggerName: string

The name of the logger that created the log record.

import { LogRecord } from "@std/log/logger";
import { LogLevels } from "@std/log/levels";
import { assertEquals } from "@std/assert/equals";

const record = new LogRecord({
msg: "Hello, world!",
args: ["foo", "bar"],
level: LogLevels.INFO,
loggerName: "example",
});

assertEquals(record.loggerName, "example");
msg: string

The message to log.

import { LogRecord } from "@std/log/logger";
import { LogLevels } from "@std/log/levels";
import { assertEquals } from "@std/assert/equals";

const record = new LogRecord({
msg: "Hello, world!",
args: ["foo", "bar"],
level: LogLevels.INFO,
loggerName: "example",
});

assertEquals(record.msg, "Hello, world!");

Accessors

  • get args(): unknown[]
  • Getter for the arguments to log.

    Returns unknown[]

    A copy of the arguments to log.

    import { LogRecord } from "@std/log/logger";
    import { LogLevels } from "@std/log/levels";
    import { assertEquals } from "@std/assert/equals";

    const record = new LogRecord({
    msg: "Hello, world!",
    args: ["foo", "bar"],
    level: LogLevels.INFO,
    loggerName: "example",
    });

    assertEquals(record.args, ["foo", "bar"]);
  • get datetime(): Date
  • Getter for the date and time the log record was created.

    Returns Date

    The date and time the log record was created.

    import { LogRecord } from "@std/log/logger";
    import { LogLevels } from "@std/log/levels";
    import { assertAlmostEquals } from "@std/assert/almost-equals";

    const record = new LogRecord({
    msg: "Hello, world!",
    args: ["foo", "bar"],
    level: LogLevels.INFO,
    loggerName: "example",
    });

    assertAlmostEquals(record.datetime.getTime(), Date.now(), 1);