ConsoleSink

Defined in: packages/app-logger/src/console-sink.ts:122

A Console implementation backed by a Logger.

Implements the standard Console interface (https://console.spec.whatwg.org/) plus the Node.js extensions (https://nodejs.org/api/console.html#console_console).

group()/groupCollapsed() open a Logger scope (scope-start/ scope-end events) instead of maintaining a hand-rolled indentation stack — any sink downstream of the Logger already knows how to nest/indent a scope.

Implements

• Console

Constructors

Constructor

new ConsoleSink(logger, options?): ConsoleSink

Defined in: packages/app-logger/src/console-sink.ts:136

Parameters

logger

Logger

The logger to write to.

options?

ConsoleSinkOptions

Optional settings for the console sink.

Returns

ConsoleSink

Properties

Console

Console: {(stdout, stderr?, ignoreErrors?): Console; (options): Console; prototype: Console; }

Defined in: packages/app-logger/src/console-sink.ts:411

Call Signature

new Console(stdout, stderr?, ignoreErrors?): Console

Parameters

stdout

WritableStream

stderr?

WritableStream

ignoreErrors?

boolean

Returns

Console

Call Signature

new Console(options): Console

Parameters

options

ConsoleOptions

Returns

Console

prototype

prototype: Console

Implementation of

Console.Console

Methods

assert()

assert(condition, …data): void

Defined in: packages/app-logger/src/console-sink.ts:169

Parameters

condition

unknown

data

…unknown[]

Returns

void

Implementation of

Console.assert

---

clear()

clear(): void

Defined in: packages/app-logger/src/console-sink.ts:191

Returns

void

Implementation of

Console.clear

---

count()

count(label): void

Defined in: packages/app-logger/src/console-sink.ts:324

Parameters

label

string

Returns

void

Implementation of

Console.count

---

countReset()

countReset(label): void

Defined in: packages/app-logger/src/console-sink.ts:332

Parameters

label

string

Returns

void

Implementation of

Console.countReset

---

debug()

debug(…data): void

Defined in: packages/app-logger/src/console-sink.ts:203

Parameters

data

…unknown[]

Returns

void

Implementation of

Console.debug

---

dir()

dir(item, options?): void

Defined in: packages/app-logger/src/console-sink.ts:309

Parameters

item

unknown

options?

InspectOptions

Returns

void

Implementation of

Console.dir

---

dirxml()

dirxml(…data): void

Defined in: packages/app-logger/src/console-sink.ts:314

Parameters

data

…unknown[]

Returns

void

Implementation of

Console.dirxml

---

error()

error(…data): void

Defined in: packages/app-logger/src/console-sink.ts:208

Parameters

data

…unknown[]

Returns

void

Implementation of

Console.error

---

group()

group(…data): void

Defined in: packages/app-logger/src/console-sink.ts:347

Parameters

data

…unknown[]

Returns

void

Implementation of

Console.group

---

groupCollapsed()

groupCollapsed(…data): void

Defined in: packages/app-logger/src/console-sink.ts:353

Parameters

data

…unknown[]

Returns

void

Implementation of

Console.groupCollapsed

---

groupEnd()

groupEnd(): void

Defined in: packages/app-logger/src/console-sink.ts:358

Returns

void

Implementation of

Console.groupEnd

---

info()

info(…data): void

Defined in: packages/app-logger/src/console-sink.ts:213

Parameters

data

…unknown[]

Returns

void

Implementation of

Console.info

---

log()

log(…data): void

Defined in: packages/app-logger/src/console-sink.ts:218

Parameters

data

…unknown[]

Returns

void

Implementation of

Console.log

---

profile()

profile(label?): void

Defined in: packages/app-logger/src/console-sink.ts:419

This method does not display anything unless used in the inspector. The console.profile() method starts a JavaScript CPU profile with an optional label until profileEnd is called. The profile is then added to the Profile panel of the inspector.

console.profile('MyLabel');
// Some code
console.profileEnd('MyLabel');
// Adds the profile 'MyLabel' to the Profiles panel of the inspector.

Parameters

label?

string

Returns

void

Since

v8.0.0

Implementation of

Console.profile

---

profileEnd()

profileEnd(label?): void

Defined in: packages/app-logger/src/console-sink.ts:424

This method does not display anything unless used in the inspector. Stops the current JavaScript CPU profiling session if one has been started and prints the report to the Profiles panel of the inspector. See profile for an example.

If this method is called without a label, the most recently started profile is stopped.

Parameters

label?

string

Returns

void

Since

v8.0.0

Implementation of

Console.profileEnd

---

table()

table(tabularData, properties?): void

Defined in: packages/app-logger/src/console-sink.ts:223

Parameters

tabularData

unknown

properties?

string[]

Returns

void

Implementation of

Console.table

---

time()

time(label): void

Defined in: packages/app-logger/src/console-sink.ts:371

Parameters

label

string

Returns

void

Implementation of

Console.time

---

timeEnd()

timeEnd(label): void

Defined in: packages/app-logger/src/console-sink.ts:393

Parameters

label

string

Returns

void

Implementation of

Console.timeEnd

---

timeLog()

timeLog(label, …data): void

Defined in: packages/app-logger/src/console-sink.ts:380

Parameters

label

string

data

…unknown[]

Returns

void

Implementation of

Console.timeLog

---

timeStamp()

timeStamp(label?): void

Defined in: packages/app-logger/src/console-sink.ts:414

This method does not display anything unless used in the inspector. The console.timeStamp() method adds an event with the label 'label' to the Timeline panel of the inspector.

Parameters

label?

string

Returns

void

Since

v8.0.0

Implementation of

Console.timeStamp

---

trace()

trace(…data): void

Defined in: packages/app-logger/src/console-sink.ts:293

Parameters

data

…unknown[]

Returns

void

Implementation of

Console.trace

---

warn()

warn(…data): void

Defined in: packages/app-logger/src/console-sink.ts:304

Parameters

data

…unknown[]

Returns

void

Implementation of

Console.warn

---

patchConsole()

static patchConsole(target, source): void

Defined in: packages/app-logger/src/console-sink.ts:156

Patches the methods of a target Console object to use the methods of a source Console object.

This can be used to redirect the output of the global console object to an instance of ConsoleSink.

Example: const consoleSink = new ConsoleSink(logger); ConsoleSink.patchConsole(console, consoleSink);

Parameters

target

Console

The target Console object to patch

source

Console

The source Console object to use for the methods

Returns

void