encore.dev/log

Enumerations

LogLevel

Enumeration Members

Debug

Debug: number

Error

Error: number

Info

Info: number

Trace

Trace: number

Warn

Warn: number

Interfaces

Logger

Methods

debug()

debug(msg, fields?): void

Debug logs a message at the debug level.

Parameters

msg

string

fields?

any

Returns

void

error()

Call Signature

error(err, fields?): void

Parameters

err

unknown

fields?

any

Returns

void

Call Signature

error(
   err, 
   msg, 
   fields?): void;

Parameters

err

unknown

msg

string

fields?

any

Returns

void

Call Signature

error(msg, fields?): void

Parameters

msg

string

fields?

any

Returns

void

info()

info(msg, fields?): void

Info logs a message at the info level.

Parameters

msg

string

fields?

any

Returns

void

trace()

trace(msg, fields?): void

Trace logs a message at the trace level.

Parameters

msg

string

fields?

any

Returns

void

warn()

Call Signature

warn(err, fields?): void

Warn logs a message at the warn level.

Parameters

err

unknown

fields?

any

Returns

void

Call Signature

warn(
   err, 
   msg, 
   fields?): void;

Warn logs a message at the warn level.

Parameters

err

unknown

msg

string

fields?

any

Returns

void

Call Signature

warn(msg, fields?): void

Warn logs a message at the warn level.

Parameters

msg

string

fields?

any

Returns

void

with()

with(fields): Logger

Returns a new logger with the given fields added to the context.

Parameters

fields

any

Returns

Logger

withLevel()

withLevel(level): Logger

Returns a new logger with the specified level.

Parameters

level

LogLevel

Returns

Logger

Type Aliases

FieldsObject

type FieldsObject = Record<string, FieldValue>

A map of fields that can be logged

FieldValue

type FieldValue = 
  | string
  | number
  | boolean
  | null
  | undefined
  | FieldsObject
  | FieldValue[];

A field value we support logging

Variables

default

const default: Logger

Functions

debug()

function debug(msg, fields?): void

Debug logs a message at the debug level

Parameters

msg

string

fields?

any

Returns

void

error()

Call Signature

function error(err, fields?): void

Error logs a message at the error level

Parameters

err

unknown

fields?

any

Returns

void

Call Signature

function error(
   err, 
   msg, 
   fields?): void;

Error logs a message at the error level

Parameters

err

unknown

msg

string

fields?

any

Returns

void

Call Signature

function error(msg, fields?): void

Error logs a message at the error level

Parameters

msg

string

fields?

any

Returns

void

info()

function info(msg, fields?): void

Info logs a message at the info level

Parameters

msg

string

fields?

any

Returns

void

trace()

function trace(msg, fields?): void

Trace logs a message at the trace level

Parameters

msg

string

fields?

any

Returns

void

warn()

Call Signature

function warn(err, fields?): void

Warn logs a message at the warn level

Parameters

err

unknown

fields?

any

Returns

void

Call Signature

function warn(
   err, 
   msg, 
   fields?): void;

Warn logs a message at the warn level

Parameters

err

unknown

msg

string

fields?

any

Returns

void

Call Signature

function warn(msg, fields?): void

Warn logs a message at the warn level

Parameters

msg

string

fields?

any

Returns

void