@haxall/haxall
    Preparing search index...

    Class ShellFuncs

    Axon shell specific functions

    Hierarchy (View Summary)

    Index

    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

    • Import data library into scope.

      Examples:

      using()                // list all libraries currently in scope
      using("phx.points") // import given library into scope
      using("*") // import every library installed

      Parameters

      • Optionalname: string

      Returns JsObj

    • Get library by qname (does not add it to using)

      Parameters

      • qname: string

      Returns Lib

    • 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

    • Print help summary or help on a specific command. Examples:

      help()        // print summary
      help(using) // print help for the using function

      Parameters

      Returns JsObj

    • Print help summary of every function

      Returns JsObj

    • Load the in-memory database from an Uri. The uri must be have http/https scheme or reference a file on the local file system (using forward slash). The filename must have one of the following file extensions: zinc, json, trio, or csv. Each record should define an id tag, or if missing then an id will assigned automatically.

      Options:

      • shortIds: will swizzle all internal refs to short ids

      Examples:

      // load from the a local file
      load(`folder/site.json`)

      // load from the a local file and use short ids
      load(`folder/site.json`, {shortIds})

      // load from a HTTP URI
      load(`https://project-haystack.org/example/download/bravo.zinc`)

      Parameters

      Returns JsObj

    • Parameters

      • ...args: unknown[]

      Returns ShellFuncs

    • Pretty print the given value.

      Options:

      • spec: "qname" | "own" | "effective"
      • doc: include spec documentation comments
      • json: pretty print dict tree as JSON
      • text: output as plain text (not string literal)
      • escapeUnicode: escape string literals with non-ASCII chars
      • width: max width of output text

      Parameters

      Returns JsObj

    • Exit the shell.

      Returns JsObj

    • Print the variables in scope

      Returns JsObj

    • Set the show error trace flag.

      Parameters

      • flag: boolean

      Returns JsObj

    • Unload all the data from the in-memory database. This is essentially a commit to remove all recs.

      Returns JsObj