Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextProcess

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected logger

logger: LoggerEvent

Methods

addHandlerAfterEmptyln

  • addHandlerAfterEmptyln(callback: (e: EventArgs) => void): void

addHandlerAfterEmptylnVerbose

  • addHandlerAfterEmptylnVerbose(callback: (e: EventArgs) => void): void

addHandlerAfterError

addHandlerAfterErrorVerbose

  • addHandlerAfterErrorVerbose(callback: (e: MsgEventAnyArgs) => void): void

addHandlerAfterWarn

addHandlerAfterWarnVerbose

addHandlerAfterWrite

addHandlerAfterWriteVerbose

  • addHandlerAfterWriteVerbose(callback: (e: MsgEventAnyArgs) => void): void

addHandlerAfterWriteln

addHandlerAfterWritelnVerbose

  • addHandlerAfterWritelnVerbose(callback: (e: MsgEventAnyArgs) => void): void

addHandlerBeforeEmptyln

addHandlerBeforeEmptylnVerbose

  • addHandlerBeforeEmptylnVerbose(callback: (e: CancelEventArgs) => void): void

addHandlerBeforeError

addHandlerBeforeErrorVerbose

  • addHandlerBeforeErrorVerbose(callback: (e: MsgEventAnyArgs) => void): void

addHandlerBeforeWarn

addHandlerBeforeWarnVerbose

  • addHandlerBeforeWarnVerbose(callback: (e: MsgEventAnyArgs) => void): void

addHandlerBeforeWrite

addHandlerBeforeWriteVerbose

  • addHandlerBeforeWriteVerbose(callback: (e: MsgEventAnyArgs) => void): void

addHandlerBeforeWriteln

addHandlerBeforeWritelnVerbose

  • addHandlerBeforeWritelnVerbose(callback: (e: MsgEventAnyArgs) => void): void

Private decodeParam

  • decodeParam(str: string): string
  • Decodes string such as \u2014 to —

    description

    Parameters are read from files with a BUILD_INCLDDE comment. Since the content is read from a file any inline javascript escapes are not automatically converted. This method does such conversions. Unescaps any \\ to \ escaped colons.

     
    For Example:
    // BUILD_INCLDDE(./somfile.txt)[text?before=\n&padleft=# \u2014]

    This method decodes the unicode, line breaks and other JavaScript encodings. This converts \n into an acutal new line and \u2014 into an em dash.

    Parameters

    • str: string

      string to decode

    Returns string

isOptionTextSet

  • Checks opts for text options and assigns any found options to biOpt

    description

    Potential options are as follows.

    Sets options for biOpt.text

    before - sets the text to append before the replacement file contents
    after - sets the text to append after the replacement file contents
    padleft - set padding string that will apply to the left of each line
    padright - set padding string that willl apply to the right of each line
    kind - set the encoding or decoding options can be encode or decode   kind=encode or kind=0 - Encodes the replacement file contents
      kind=decode or kind=1 - Decodes the replacement file contents

    code - the ekind of encoding or decodeing can be base64, base64uri, jsString, uri
      code=uri or code=0 - Encodes / Decodes the replacement file contents as URI
      code=uriComponent or code=1 - Encodes / Decodes the replacement file contents as uriComponent
      code=base64 or code=2 - Encodes / Decodes the replacement file contents as base64
      code=base64Uri or code=3 - Encodes / Decodes the replacement file contents as base64Uri
      code=jsString or code=4 - Encodes / Decodes the replacement file contents as as JavaScript string
      code=tsString or code=5 - Encodes / Decodes the replacement file contents as as TypeScript string

    example
    
    // BUILD_INCLUDE('../myjavascript.js')[text?padleft=10&before=// injected from file\n&code=jsString]

    Parameters

    • opts: string[]

      The array of options to search for Text options in

    • biOpt: IBuildIncludeOpt

      The current options. This parameter is an object and will be potentially modified by this method.

    Returns boolean

    true if opts has text options; Otherwise, false.

registerLoggerEvents

  • registerLoggerEvents(loggerEvent: ILogger): void

removeHandlerAfterEmptyln

  • removeHandlerAfterEmptyln(callback: (e: EventArgs) => void): void

removeHandlerAfterEmptylnVerbose

  • removeHandlerAfterEmptylnVerbose(callback: (e: EventArgs) => void): void

removeHandlerAfterError

removeHandlerAfterErrorVerbose

  • removeHandlerAfterErrorVerbose(callback: (e: MsgEventAnyArgs) => void): void

removeHandlerAfterWarn

removeHandlerAfterWarnVerbose

  • removeHandlerAfterWarnVerbose(callback: (e: MsgEventAnyArgs) => void): void

removeHandlerAfterWrite

removeHandlerAfterWriteVerbose

  • removeHandlerAfterWriteVerbose(callback: (e: MsgEventAnyArgs) => void): void

removeHandlerAfterWriteln

removeHandlerAfterWritelnVerbose

  • removeHandlerAfterWritelnVerbose(callback: (e: MsgEventAnyArgs) => void): void

removeHandlerBeforeEmptyln

removeHandlerBeforeEmptylnVerbose

  • removeHandlerBeforeEmptylnVerbose(callback: (e: CancelEventArgs) => void): void

removeHandlerBeforeError

removeHandlerBeforeErrorVerbose

  • removeHandlerBeforeErrorVerbose(callback: (e: MsgEventAnyArgs) => void): void

removeHandlerBeforeWarn

removeHandlerBeforeWarnVerbose

  • removeHandlerBeforeWarnVerbose(callback: (e: MsgEventAnyArgs) => void): void

removeHandlerBeforeWrite

removeHandlerBeforeWriteVerbose

  • removeHandlerBeforeWriteVerbose(callback: (e: MsgEventAnyArgs) => void): void

removeHandlerBeforeWriteln

removeHandlerBeforeWritelnVerbose

  • removeHandlerBeforeWritelnVerbose(callback: (e: MsgEventAnyArgs) => void): void

unRegisterLoggerEvents

  • unRegisterLoggerEvents(loggerEvent: ILogger): void

Generated using TypeDoc