Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FenceProcess

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected logger

logger: LoggerEvent

Static Protected DEFAULT_FENCE_END

DEFAULT_FENCE_END: string = `^({0})(?:(?:$)|(?:[\\r\\n]+))`

Static Protected DEFAULT_FENCE_START

DEFAULT_FENCE_START: string = `^({0})(?:([a-zA-Z]+)?(?:[\\r\\n]+))(?:[\\s\\S]+?)`

Static Protected DEFAULT_INDEX_END

DEFAULT_INDEX_END: number = 0

Static Protected DEFAULT_INDEX_START

DEFAULT_INDEX_START: number = 0

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 buildFenceMultiRegex

  • buildFenceMultiRegex(): RegExp | undefined

  • Combines [[strictFence]], [[tildeFence]] and [[escapeFence]] into one regular expression.

    Returns RegExp | undefined

Private buildFenceRegex

  • buildFenceRegex(fence: IFence): RegExp

getOptionFence

  • Checks if fence options are assigned in the form of string, number or object. If assigend then return value will be converted to of IFence

    Parameters

    Returns IFence | undefined

isOptionFenceSet

  • Get fence options

    Parameters

    • opts: string[]

      The array of options to search for fence 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 fence options; Otherwise, false.

Private isRegexStr

  • isRegexStr(s: string): boolean

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

Static Private assignFenceProperties

Static getFenceKind

  • Gets a fence that it has has a start and end that can be used to build a regular expression for processing fences in text.

    Parameters

    • kind: fenceKind

      The kind of fence to return

    Returns IOptFence | undefined

Static getFenceOptions

  • getFenceOptions(fence: string | number | IOptFence | undefined): RegExp | undefined

  • Creates a regular expression from fence. The regular expression is used to match fences in content.

    Example Fenced text:

    ```text
This text is fenced
```

    Parameters

    • fence: string | number | IOptFence | undefined

      fenceKind enumeration value or object instance of IOptFence or undefined.

      If fence is string then it is parsed as fenceKind. If fence is undefined then return result will also be undefined.

    Returns RegExp | undefined

    If fence can be converted to regular expression then a regular expression is returned; Otherwise, undefined.

Generated using TypeDoc