import {Log} from 'hiplog/src/index.js'

public class | source

Log

Fancy lightweight logging utility.

Test:

Constructor Summary

Public Constructor
public	constructor(options: Log~options): Log Creates an instance of `Log`.

Member Summary

Public Members
public	[level](parts: ...): undefined: Logging method for each level of `options.levels`.
public get	level: number: *
public	options: *

Method Summary

Public Methods
public	buildBody(parts: *[]): string Build the body.
public	buildHeader(level: number): string Build the header.
public	buildMessage(level: number, parts: *[]): string Build the entire message.
public	write(level: number, parts: *[]): undefined Build a message and write it to the stream.

Public Constructors

public constructor(options: Log~options): Log source

Creates an instance of Log.

Params:

Name	Type	Attribute	Description
options	Log~options	optional default: {}	Options.

Return:

Log	A new instance of Log.

Public Members

public [level](parts: ...): undefined: source

Logging method for each level of options.levels.

Return:

undefined

Nothing.

public get level: number: * source

Properties:

Name	Type	Attribute	Description
level	number		Integer value of `this.options.level`.

Return:

number

The level.

Return Properties:

Name	Type	Attribute	Description
level	number		Integer value of `this.options.level`.

public options: * source

Public Methods

public buildBody(parts: *[]): string source

Build the body.

Params:

Name	Type	Attribute	Description
parts	*[]		Parts of the message, not formatted.

Return:

string

The constructed body.

public buildHeader(level: number): string source

Build the header.

Params:

Name	Type	Attribute	Description
level	number		Level number.

Return:

string

The constructed header.

public buildMessage(level: number, parts: *[]): string source

Build the entire message.

Params:

Name	Type	Attribute	Description
level	number		Level number.
parts	*[]		Parts of the message, not formatted.

Return:

string

The constructed message.

public write(level: number, parts: *[]): undefined source

Build a message and write it to the stream.

Params:

Name	Type	Attribute	Description
level	number		Level number.
parts	*[]		Parts of the message, not formatted.

Return:

undefined

Nothing.

Log

Test:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(options: Log~options): Log source

Params:

Return:

Public Members

public [level](parts: ...*): undefined: * source

Return:

public get level: number: * source

Properties:

Return:

Return Properties:

public options: * source

Public Methods

public buildBody(parts: *[]): string source

Params:

Return:

public buildHeader(level: number): string source

Params:

Return:

public buildMessage(level: number, parts: *[]): string source

Params:

Return:

public write(level: number, parts: *[]): undefined source

Params:

Return:

public [level](parts: ...): undefined: source