@haxall/haxall
    Preparing search index...

    Class XmlFuncs

    XML Axon functions

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    type$

    Methods

    compare equals hash isImmutable toImmutable toStr trap typeof with echo make xmlAttr xmlAttrs xmlElem xmlElems xmlName xmlNs xmlPrefix xmlQname xmlRead xmlVal

    Constructors

    Properties

    type$: Type

    Methods

    • 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

    • 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 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

    • Parameters

      • ...args: unknown[]

      Returns XmlFuncs

    • Get an attribute from an element by its non-qualified local name. If the attribute is not found and checked is false then return null otherwise throw XErr.

      Examples:

      xmlRead("<x a='v'/>").xmlAttr("a").xmlVal   >>  "v"
      xmlRead("<x/>").xmlAttr("a", false).xmlVal  >>  null

      Parameters

      • elem: XElem
      • name: string
      • Optionalchecked: boolean

      Returns XAttr

    • Get list of all an elements attributes.

      Example:

      attrs: xmlRead("<x a='' b=''/>").xmlAttrs
      attrs.map(xmlName)  >>  ["a", "b"]

      Parameters

      Returns List<XAttr>

    • Find an element by its non-qualified local name. If there are multiple child elements with the name, then the first one is returned. If the element is not found and checked is false then return null otherwise throw XErr.

      Example:

      xmlRead("<d><a/></d>").xmlElem("a")

      Parameters

      • elem: XElem
      • name: string
      • Optionalchecked: boolean

      Returns XElem

    • Get the children elements. If this element contains text or PI nodes, then they are excluded in the result.

      Example:

      elems: xmlRead("<d><a/><b/></d>").xmlElems
      elems.map(xmlName)  >>  ["a", "b"]

      Parameters

      Returns List<XElem>

    • Get the unqualified local name of an element or attribute:

      <foo>    >>  "foo"
      <x:foo>  >>  "foo"

      Parameters

      Returns string

    • Get the namespace URI of an element or attribute. If no namespace was specified return null.

      Example:

      xmlRead("<foo xmlns='bar'/>").xmlNs  >>  `bar`

      Parameters

      Returns Uri

    • Get the namespace prefix of an element or attribute. If node is an element in the default namespace then return "". If no namespace is specified return null.

      Examples:

      <foo>               >>  null
      <x:foo>             >>  "x"
      <foo xmlns='...'/>  >>  ""

      Parameters

      Returns string

    • Get the qualified local name of an element or attribute which includes both its prefix and unqualified name:

      <foo>    >>  "foo"
      <x:foo>  >>  "x:foo"

      Parameters

      Returns string

    • Parse an XML document from an I/O handle and return root element.

      Examples:

      xmlRead("<foo/>")
      xmlRead(`io/test.xml`)

      Parameters

      Returns XElem

    • If node is an attribute, then return its value string. If node is an element return its first text child node, otherwise null. If node is null, then return null.

      Examples:

      xmlRead("<x/>").xmlVal                      >>  null
      xmlRead("<x>hi</x>").xmlVal                 >>  "hi"
      xmlRead("<x a='v'/>").xmlAttr("a").xmlVal   >>  "v"
      xmlRead("<x/>").xmlAttr("a", false).xmlVal  >>  null

      Parameters

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods