Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptComment

Comment option.
Comments options set in configuration are merged with any comment options set in the file that contains the build_include ( or varation of ). File level options will always take priority unless override is set to true.

Example

 
bp = new BuildProcess();
const opt = {
  match: {
    kind: 'bracketInclude',
    path: './scratch/'
  },
  comment: {
    padleft: 2,
    type: 'singleAsterisk'
  }
};
const results = bp.buildInclude('','./includes/replace.js', opt);

Hierarchy

  • IOptComment

Index

Properties

Properties

Optional padleft

padleft: string | number

A value of string or number to apply before each line of a comment.
String value is literal padding.
Number will be converted into spaces,

Optional type

type: string | number

can be any enum value of: commentKind such as 'jsdoc'

Generated using TypeDoc