Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pretty

Utility to print pretty formatted tree-representation of any javacript data.

This class represens basic API and works both ways:

  • as a constructable via new Pretty(themeStack) instance,
  • or as a static class with oneshot functions Pretty.print and Pretty.stringify
export
class

Pretty

Hierarchy

  • Pretty

Index

Constructors

Methods

Constructors

constructor

Methods

print

  • Prints pretty formatted tree-representation of any javacript data. Use options to customize output.

    remarks

    Use options.logLineCallback for custom console.log handler, or pretty.stringifyTree to render tree to a string.

    remarks

    Cycle-referencing is allowed, while capping output with finite options.maxLevel and options.maxItemsPerLevel.

    memberof

    Pretty

    Parameters

    • tree: any

      Any javacript data

    • Optional rootKey: any
    • Optional options: printTreeOptionsT

    Returns void

stringify

  • Renders pretty formatted tree-representation of any javacript data to string. Use options to customize output.

    remarks

    Works same as pretty.print, but use predefined logLineCallback for dumping output to string. Consider Using pretty.print if you need a per-line callback API, or if you just want a simple oneliner with default options.logLineCallback

    remarks

    Cycle-referencing is allowed, while capping output with finite options.maxLevel and options.maxItemsPerLevel.

    memberof

    Pretty

    Parameters

    Returns string

Static print

  • Prints pretty formatted tree-representation of any javacript data. Use options to customize output.

    remarks

    Static "oneshot" version of pretty.print. Easier to use, because no need to create new Pretty(), but it prebuilds theme each time it starts, while long-living new Pretty() keep prebuilded theme and reused it.

    remarks

    Options are printTreeOptionsT plus themeStack property. Which is intended for Pretty constructor to create short-living new Pretty(themeStack).

    remarks

    Use options.logLineCallback for custom console.log handler, or pretty.stringifyTree to render tree to a string.

    remarks

    Cycle-referencing is allowed, while capping output with finite options.maxLevel and options.maxItemsPerLevel.

    static
    memberof

    Pretty

    Parameters

    Returns void

Static stringify

  • Renders pretty formatted tree-representation of any javacript data to string. Use options to customize output.

    remarks

    Static "oneshot" version of pretty.print. Easier to use, because no need to create new Pretty(), but it prebuilds theme each time it starts, while long-living new Pretty() keep prebuilded theme and reused it.

    remarks

    Options are stringifyTreeOptionsT plus themeStack property. Which is intended for Pretty constructor to create short-living new Pretty(themeStack).

    remarks

    Works same as pretty.print, but use predefined logLineCallback for dumping output to string. Consider Using pretty.print if you need a per-line callback API, or if you just want a simple oneliner with default options.logLineCallback.

    remarks

    Cycle-referencing is allowed, while capping output with finite options.maxLevel and options.maxItemsPerLevel.

    static
    memberof

    Pretty

    Parameters

    Returns string

Generated using TypeDoc