API Reference

PrettyPrinterclass

Formats values into readable text for diagnostics and debug output.

Overview

Used for logging, diagnostics, and debugging helper output in core services.
Quick facts
Kind
class
Module
error-log
Members
3
Package
@rs-x/core

Import

import { PrettyPrinter } from '@rs-x/core';

Example

import { PrettyPrinter } from '@rs-x/core';

const instance = new PrettyPrinter(...args);

Members

3 members in this class.

constructor
constructorpublic
constructor(indent: number = 4)

Parameters

NameTypeRequired
indent?numberoptional
toLines
methodpublic
public toLines(
  value: unknown,
  level: number = 0,
  quoteStrings: boolean = true,
  options?: IPrettyPrinterOptions
): string[]

Parameters

NameTypeRequired
valueunknownrequired
level?numberoptional
quoteStrings?booleanoptional
options?IPrettyPrinterOptionsoptional

Returns

string[]

toString
methodpublic
public toString(
  value: unknown,
  quoteStrings: boolean = true,
  options?: IPrettyPrinterOptions
): string

Parameters

NameTypeRequired
valueunknownrequired
quoteStrings?booleanoptional
options?IPrettyPrinterOptionsoptional

Returns

string