@zturnlibs/ztron-api


log

Interfaces

AttachConsoleOptions

Defined in: log.ts:48

Properties

logger?

optional logger?: (message) => void

Defined in: log.ts:50

Custom sink for each record (default: console.log).

Parameters
message

string

Returns

void

Type Aliases

LogLevel

LogLevel = "trace" | "debug" | "info" | "warn" | "error"

Defined in: log.ts:5


LogSink

LogSink = (record) => void

Defined in: log.ts:8

A client-side logger sink (upstream attachLogger shape).

Parameters

record
level

LogLevel

payload

string

Returns

void

Variables

logger

const logger: object

Defined in: log.ts:46

Type Declaration

debug

debug: (m) => Promise<void>

Parameters
m

string

Returns

Promise<void>

error

error: (m) => Promise<void>

Parameters
m

string

Returns

Promise<void>

info

info: (m) => Promise<void>

Parameters
m

string

Returns

Promise<void>

log

log: (level, message) => Promise<void>

Parameters
level

LogLevel

message

string

Returns

Promise<void>

trace

trace: (m) => Promise<void>

Parameters
m

string

Returns

Promise<void>

warn

warn: (m) => Promise<void>

Parameters
m

string

Returns

Promise<void>

Functions

attachConsole()

attachConsole(options?): Promise<UnlistenFn>

Defined in: log.ts:59

Mirrors @tauri-apps/plugin-log's attachConsole: subscribes to the records the backend log plugin pushes for every entry when running with the webview target (via the addPluginListener('log','log',…) contract). Returns an unlisten function.

Parameters

options?

AttachConsoleOptions = {}

Returns

Promise<UnlistenFn>


attachLogger()

attachLogger(sink): () => void

Defined in: log.ts:20

Registers a client-side logger sink receiving every log* call made from this page (upstream attachLogger parity for the webview target; backend targets keep their own sinks).

Parameters

sink

LogSink

Returns

() => void


debug()

debug(m): Promise<void>

Defined in: log.ts:41

Parameters

m

string

Returns

Promise<void>


detachLogger()

detachLogger(sink): void

Defined in: log.ts:26

Removes a previously attached sink.

Parameters

sink

LogSink

Returns

void


error()

error(m): Promise<void>

Defined in: log.ts:44

Parameters

m

string

Returns

Promise<void>


info()

info(m): Promise<void>

Defined in: log.ts:42

Parameters

m

string

Returns

Promise<void>


log()

log(level, message): Promise<void>

Defined in: log.ts:30

Parameters

level

LogLevel

message

string

Returns

Promise<void>


trace()

trace(m): Promise<void>

Defined in: log.ts:40

Parameters

m

string

Returns

Promise<void>


warn()

warn(m): Promise<void>

Defined in: log.ts:43

Parameters

m

string

Returns

Promise<void>