Skip to main content

@rbxts/rlog > robloxConsoleSink

robloxConsoleSink() function​

The default sink for sending messages to the roblox console.

Signature:

export declare function robloxConsoleSink(params?: RobloxConsoleSinkConfig): (entry: LogEntry) => void;

Parameters​

Parameter

Type

Description

params

RobloxConsoleSinkConfig

(Optional) RobloxConsoleSinkConfig options for this sink.

Returns:

(entry: LogEntry) => void

A sink that should be added to a config.

Remarks​

By default, this is already applied at the root level through the default instance.

Example​

const logger = new rLog({
  sinks: [
     robloxConsoleSink({ formatMethod: myCustomMethod }),
  ],
});