Skip to content
Tauri
Releases

@tauri-apps/plugin-log

Type Aliases

LogOptions

type LogOptions: object;

Type declaration

MemberType
filestring
keyValuesRecord<string, string | undefined>
linenumber

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

Functions

attachConsole()

function attachConsole(): Promise<UnlistenFn>

Returns

Promise<UnlistenFn>

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


debug()

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

Logs a message at the debug level.

Parameters

ParameterTypeDescription
messagestring

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>

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


error()

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

Logs a message at the error level.

Parameters

ParameterTypeDescription
messagestring

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>

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


info()

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

Logs a message at the info level.

Parameters

ParameterTypeDescription
messagestring

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>

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


trace()

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

Logs a message at the trace level.

Parameters

ParameterTypeDescription
messagestring

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>

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


warn()

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

Logs a message at the warn level.

Parameters

ParameterTypeDescription
messagestring

Examples

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

const warn_description = “Invalid Input”;

warn(Warning! {warn_description}!);

options?LogOptions-

Returns

Promise<void>

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


© 2024 Tauri Contributors. CC-BY / MIT