@haxall/haxall
    Preparing search index...

    Class MarkdownWriter

    Writer for Markdown (CommonMark) text.

    Hierarchy (View Summary)

    • Obj
      • MarkdownWriter
    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Wheter we're at the line start (not counting any prefixes), i.e. after a line or block.

      Returns boolean

    • Wheter we're at the line start (not counting any prefixes), i.e. after a line or block.

      Parameters

      • it: boolean

      Returns void

    • Enqueue a block separator to be written before the next text is written. Block separators are not written straight away because if there are no more blocks to write, we don't want a separator (at the end of the document)

      Returns void

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • The last character that was written

      Returns number

    • The last character that was written

      Parameters

      • it: number

      Returns void

    • Write a newline (line terminator).

      Returns void

    • Remove the last prefix from the top of the stack

      Returns void

    • Remove the last raw escape from the top of the stack

      Returns void

    • Remove the last "tight" setting from the top of the stack

      Returns void

    • Push a prefix onto the top of the stack. All prefixes are written at the beginning of each line, until the prefix is popped again.

      Parameters

      • prefix: string

      Returns void

    • Escape the characters matching the supplied matcher, in all text (text and raw). This might be usefult to extensions that add another layer of syntax, e.g. the tables extension that uses | to separate cells and needs all | characters to be escaped (even in code spans)

      Parameters

      • rawEscape: (arg0: number) => boolean

      Returns void

    • Change whether blocks are tight or loose. Loose is the default where blocks are separated by a blank line. Tight is where blocks are not separated by a blank line. Tight blocks are used in lists, if there are no blank lines within the list.

      Note that changing this does not affect block separators that have already been enqueued with block, only future ones.

      Parameters

      • tight: boolean

      Returns void

    • Write the supplied string or character (raw/unescaped except if pushRawEscape was used).

      Parameters

      Returns void

    • Write the supplied string with escaping

      Parameters

      • s: string
      • Optionalescape: (arg0: number) => boolean

      Returns void

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write a prefix

      Parameters

      • prefix: string

      Returns void

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void