Fastkit

Builder API

Builder

loggerBuilder
function

# Signature
(opts?: LoggerBuilderOptions): LoggerBuilderResult

Generate loggers corresponding to the specified options

# Parameters
NameTypeDefault
optsLoggerBuilderOptions{}
Logger builder options
# Return Type
LoggerBuilderResult

Logger generation results

LoggerBuilderOptions
class

Logger builder options

defaultSettings
optional

undefined | LoggerOptions

Default logger options

  • Used as base option for all unnamed and named loggers

namedSettings
optional

undefined | LoggerNamedSettings

Map of logger options by name

LoggerBuilderResult
class

Logger generation results

getLogger

(name?: string) => Logger

Retrieve loggers with specified name

  • If no name is specified, the default logger name default will be set
  • Once a logger instance is created, it is cached and will be reused the next time a logger acquisition request with the same name is made.

getNamedSettings

(name: string) => NormalizedLoggerOptions

Retrieves logger options corresponding to the specified logger name

Logger

typeof Logger

Constructor of the generated logger class

  • Normally it is not necessary to instantiate a logger from this constructor. To retrieve the logger, use the getLogger() method.

Logger

Logger
class

Logger

# Signature
(name: string, opts: NormalizedLoggerOptions): Logger
# Parameters
NameTypeDefault
name*string
opts*NormalizedLoggerOptions
# Return Type
Logger

name
readonly

string

Logger Name

transformers
readonly

Transformer[]

List of log transform functions

transports
readonly

Transport[]

List of Log transporter

level

"silent" | "error" | "warn" | "info" | "trace" | "debug"

Log level thresholds that determine log output

log
function

# Signature
(level: LogLevel, ...args: any[]): Promise<any[]>

Output logs at a specified log level

# Parameters
NameTypeDefault
level*"error" | "warn" | "info" | "trace" | "debug"
Log level
argsany[]
List of log arguments
# Return Type
Promise<any[]>

Promise instance of log output result

trace
function

# Signature
(...args: any[]): Promise<any[]>

Output logs at the trace level

# Parameters
NameTypeDefault
argsany[]
List of log arguments
# Return Type
Promise<any[]>

Promise instance of log output result

debug
function

# Signature
(...args: any[]): Promise<any[]>

Output logs at the debug level

# Parameters
NameTypeDefault
argsany[]
List of log arguments
# Return Type
Promise<any[]>

Promise instance of log output result

info
function

# Signature
(...args: any[]): Promise<any[]>

Output logs at the info level

# Parameters
NameTypeDefault
argsany[]
List of log arguments
# Return Type
Promise<any[]>

Promise instance of log output result

warn
function

# Signature
(...args: any[]): Promise<any[]>

Output logs at the warn level

# Parameters
NameTypeDefault
argsany[]
List of log arguments
# Return Type
Promise<any[]>

Promise instance of log output result

error
function

# Signature
(...args: any[]): Promise<any[]>

Output logs at the error level

# Parameters
NameTypeDefault
argsany[]
List of log arguments
# Return Type
Promise<any[]>

Promise instance of log output result

Schemes

LogLevel

"error" | "warn" | "info" | "trace" | "debug"

Available log level

LogLevelThreshold

"silent" | "error" | "warn" | "info" | "trace" | "debug"

Log level thresholds that determine log output

  • If silent is specified, no log is output

LoggerOptions
class

Logger Options

level
optional

undefined | "silent" | "error" | "warn" | "info" | "trace" | "debug"

Log level thresholds that determine log output

transformers
optional

undefined | Transformer[]

List of transform functions

transports
optional

undefined | RawTransport[]

List of log output function

LoggerPayload
class

Logger payload

This payload is passed on to the transformer or transport method in turn

level

"error" | "warn" | "info" | "trace" | "debug"

Log level

logger

{ name: string; }

Logger Information

message

string

Message

args

any[]

List of arguments passed to the logger

meta

M

Logger Meta Information

error
optional

undefined | { index: number; instance: Error; }

The first error detected from the arguments.

Transformer
function

# Signature
(payload: LoggerPayload): LoggerPayload
# Parameters
NameTypeDefault
payload*LoggerPayload<Meta>
# Return Type
LoggerPayload<Meta>

Log transform function

Function to convert the passed payload.

TransportFunc
function

# Signature
(payload: LoggerPayload): any | Promise<any>
# Parameters
NameTypeDefault
payload*LoggerPayload<Meta>
# Return Type
any

Log output function

Function to output and send the passed payload to standard output, external logging services, etc.

Transport
class

Log transporter

level
optional

undefined | "silent" | "error" | "warn" | "info" | "trace" | "debug"

Log level thresholds that determine log output

  • If not set, the threshold set in the logger will be selected

transformers
optional

undefined | Transformer[]

List of transform functions

transport

TransportFunc

Log output function