WrapResult | text-wrapper

The return value of the main operation of this library (wrapping texts) would be of this type. Although the final output will be stored in wrappedText and you regularly need this, but there is also a more advanced output: markers.

Hierarchy

WrapResult

Index

Properties

markers
wrappedText

Properties

markers

markers: number[]

Each member of this array would point to a location that a line-break (possibly: line-break + indentation) is needed.

So you can reproduce the final output (wrappedText) completely using this array + your original input.

wrappedText

wrappedText: string

The final output. This would be as same as the your original input, but in addition to a few break-line characters + possibly indentations ('\n' + calculated_indentations).

see: alreadyPresentIndentation in {@linkcode TextWrapper.wrap.alreadyPresentIndentation wrap()}
see: WrapOptions.continuationIndent

Generated using TypeDoc