Options
All
  • Public
  • Public/Protected
  • All
Menu

Breakstring end of line options

Determines how a to handle line ending with breaking a string into array.
Default is breakstring?eol=noLnBr.

Breakstring eol encode

{breakstring: { eol: "encode" }} or inline breakstring?eol=encode
Determines that line breaks are not to removed during proccessing but rather encoded into the output as \n.

Breakstring eol noLnBr

{breakstring: { eol: "noLnBr" }} or inline breakstring?eol=noLnBr
Default: Remove Line Breaks.

Breakstring eol none

{breakstring: { eol: "none" }} or inline breakstring?eol=none
Determines that line breaks are not touched and remain part of the output.

EXAMPLE

With the configuration below all inline BUILD_INCLUDE statments would have asJsString applied and each BUILD_INCLUE file would be split into lines that are 100 characters wide with extra line breaks removed using breakstring.

Config

const bp = new BuildProcess();
const opt = {
  match: {
    kind: "buildIncludeSlash"
  },
  asJsString: true,
  breakstring: {
    width: 100,
    break: 'width',
    eol: 'noLnBr'
  }
  override: true
}
const results = bp.buildInclude('','./includes/replace.txt', opt);

breakstring
Build-include Options

Generated using TypeDoc