@tauri-apps/plugin-log

Functions

attachConsole()

function attachConsole(): Promise<UnlistenFn>;

Defined in: plugins/log/guest-js/index.ts:277

Attaches a listener that writes log entries to the console as they come in.

Returns

Promise<UnlistenFn>

a function to cancel the listener.

---

attachLogger()

function attachLogger(fn: LoggerFn): Promise<UnlistenFn>;

Defined in: plugins/log/guest-js/index.ts:256

Attaches a listener for the log, and calls the passed function for each log entry.

Parameters

Parameter	Type	Description
fn	LoggerFn	-

Returns

Promise<UnlistenFn>

a function to cancel the listener.

---

debug()

function debug(message: string, options?: LogOptions): Promise<void>;

Defined in: plugins/log/guest-js/index.ts:214

Logs a message at the debug level.

Parameters

Parameter	Type	Description
message	string	# Examples import { debug } from '@tauri-apps/plugin-log'; const pos = { x: 3.234, y: -1.223 }; debug(New position: x: {pos.x}, y: {pos.y});
options?	LogOptions	-

Returns

Promise<void>

---

error()

function error(message: string, options?: LogOptions): Promise<void>;

Defined in: plugins/log/guest-js/index.ts:148

Logs a message at the error level.

Parameters

Parameter	Type	Description
message	string	# Examples import { error } from '@tauri-apps/plugin-log'; const err_info = "No connection"; const port = 22; error(Error: ${err_info} on port ${port});
options?	LogOptions	-

Returns

Promise<void>

---

info()

function info(message: string, options?: LogOptions): Promise<void>;

Defined in: plugins/log/guest-js/index.ts:192

Logs a message at the info level.

Parameters

Parameter	Type	Description
message	string	# Examples import { info } from '@tauri-apps/plugin-log'; const conn_info = { port: 40, speed: 3.20 }; info(Connected to port {conn_info.port} at {conn_info.speed} Mb/s);
options?	LogOptions	-

Returns

Promise<void>

---

trace()

function trace(message: string, options?: LogOptions): Promise<void>;

Defined in: plugins/log/guest-js/index.ts:236

Logs a message at the trace level.

Parameters

Parameter	Type	Description
message	string	# Examples import { trace } from '@tauri-apps/plugin-log'; let pos = { x: 3.234, y: -1.223 }; trace(Position is: x: {pos.x}, y: {pos.y});
options?	LogOptions	-

Returns

Promise<void>

---

warn()

function warn(message: string, options?: LogOptions): Promise<void>;

Defined in: plugins/log/guest-js/index.ts:170

Logs a message at the warn level.

Parameters

Parameter	Type	Description
message	string	# Examples import { warn } from '@tauri-apps/plugin-log'; const warn_description = "Invalid Input"; warn(Warning! {warn_description}!);
options?	LogOptions	-

Returns

Promise<void>

Enumerations

LogLevel

Defined in: plugins/log/guest-js/index.ts:14

Enumeration Members

Enumeration Member	Value	Description	Defined in
Debug	2	The “debug” level. Designates lower priority information.	plugins/log/guest-js/index.ts:26
Error	5	The “error” level. Designates very serious errors.	plugins/log/guest-js/index.ts:44
Info	3	The “info” level. Designates useful information.	plugins/log/guest-js/index.ts:32
Trace	1	The “trace” level. Designates very low priority, often extremely verbose, information.	plugins/log/guest-js/index.ts:20
Warn	4	The “warn” level. Designates hazardous situations.	plugins/log/guest-js/index.ts:38

Interfaces

LogOptions

Defined in: plugins/log/guest-js/index.ts:8

Properties

Property	Type	Defined in
file?	string	plugins/log/guest-js/index.ts:9
keyValues?	Record<string, string | undefined>	plugins/log/guest-js/index.ts:11
line?	number	plugins/log/guest-js/index.ts:10