Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ItemOptions

the options to configure the "default" output of the item

Hierarchy

  • ItemOptions

Properties

Optional depth

depth: number

at which object / array depth, other objects / arrays should just be displayed as their type + length. defaults to infinity

Optional printFunction

printFunction: boolean

should a function be printed with its complete declaration. defaults to false

Optional indent

indent: number

the indent that nested objects / arrays have (when not shortened to 1 line). defaults to 2

Optional showVerticalLines

showVerticalLines: boolean

should vertical indent indicator lines be printed. defaults to true

Optional keys

keys: string[]

filtered keys for objects.

  • helpful for larger objects
  • other keys will not be displayed
  • objects and arrays that deeply contain the given keys will have an indicator of how many elements where left out

Optional shortenClasses

shortenClasses: boolean

shortens objects that have a specific constructor name (other than 'Object') as their name

  • defaults to true (except if the item itself is a class)
  • if disabled, the object will be displayed as destructed object with its properties
  • ATTENTION displaying nested classes (classes have classes as props) can lead to exceeding the stack size, especially if the contain cyclic structures

Generated using TypeDoc