@tauri-apps/plugin-log

Configure the Tauri application log system, and access the JavaScript-side log functions.

Enumerations

LogLevel

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L29

The verbosity level of a log entry, matching the levels of the Rust log crate.

Enumeration Members

Debug

Debug: 2;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L41

The “debug” level.

Designates lower priority information.

Error

Error: 5;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L59

The “error” level.

Designates very serious errors.

Info

Info: 3;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L47

The “info” level.

Designates useful information.

Trace

Trace: 1;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L35

The “trace” level.

Designates very low priority, often extremely verbose, information.

Warn

Warn: 4;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L53

The “warn” level.

Designates hazardous situations.

Interfaces

LogOptions

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L17

Options to associate extra metadata with a log entry.

Properties

Property	Type	Description	Defined in
file?	string	The name of the file that emitted the log entry. Included in the log record’s target when set.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L19
keyValues?	Record<string, string | undefined>	Additional structured key-value pairs to attach to the log entry.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L23
line?	number	The line number in LogOptions.file that emitted the log entry.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L21

Functions

attachConsole()

function attachConsole(): Promise<UnlistenFn>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L321

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

Returns

Promise<UnlistenFn>

a promise resolving to a function to cancel the listener.

Example

import { attachConsole } from '@tauri-apps/plugin-log';

const detach = await attachConsole();

// detach the listener later
detach();

Since

2.0.0

---

attachLogger()

function attachLogger(fn): Promise<UnlistenFn>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L289

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

Parameters

Parameter	Type	Description
fn	LoggerFn	a function to call for every log entry emitted by the Rust side.

Returns

Promise<UnlistenFn>

a promise resolving to a function to cancel the listener.

Example

import { attachLogger } from '@tauri-apps/plugin-log';

const detach = await attachLogger(({ level, message }) => {
  console.log(`[${level}] ${message}`);
});

// detach the listener later
detach();

Since

2.0.0

---

debug()

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

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L233

Logs a message at the debug level.

Parameters

Parameter	Type	Description
message	string	the message to log.
options?	LogOptions	additional metadata (file, line, key-values) to attach to the log entry.

Returns

Promise<void>

Example

import { debug } from '@tauri-apps/plugin-log';

const pos = { x: 3.234, y: -1.223 };

debug(`New position: x: {pos.x}, y: {pos.y}`);

Since

2.0.0

---

error()

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

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L164

Logs a message at the error level.

Parameters

Parameter	Type	Description
message	string	the message to log.
options?	LogOptions	additional metadata (file, line, key-values) to attach to the log entry.

Returns

Promise<void>

Example

import { error } from '@tauri-apps/plugin-log';

const err_info = "No connection";
const port = 22;

error(`Error: ${err_info} on port ${port}`);

Since

2.0.0

---

info()

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

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L210

Logs a message at the info level.

Parameters

Parameter	Type	Description
message	string	the message to log.
options?	LogOptions	additional metadata (file, line, key-values) to attach to the log entry.

Returns

Promise<void>

Example

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`);

Since

2.0.0

---

trace()

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

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L256

Logs a message at the trace level.

Parameters

Parameter	Type	Description
message	string	the message to log.
options?	LogOptions	additional metadata (file, line, key-values) to attach to the log entry.

Returns

Promise<void>

Example

import { trace } from '@tauri-apps/plugin-log';

let pos = { x: 3.234, y: -1.223 };

trace(`Position is: x: {pos.x}, y: {pos.y}`);

Since

2.0.0

---

warn()

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

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/log/guest-js/index.ts#L187

Logs a message at the warn level.

Parameters

Parameter	Type	Description
message	string	the message to log.
options?	LogOptions	additional metadata (file, line, key-values) to attach to the log entry.

Returns

Promise<void>

Example

import { warn } from '@tauri-apps/plugin-log';

const warn_description = "Invalid Input";

warn(`Warning! {warn_description}!`);

Since

2.0.0