@haxall/haxall
    Preparing search index...

    Class ShellContext

    Shell context

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Return empty dict

      Returns Dict

    • Lookup and call a function with the given arguments. The arguments must be fully evaluated values such as Numbers, Dicts, Grids, etc.

      Parameters

      Returns JsObj

    • Return if context has read access to given record

      Parameters

      Returns boolean

    • Return if context has write (update/delete) access to given record

      Parameters

      Returns boolean

    • If missing admin permission, throw PermissionErr

      Parameters

      • action: string

      Returns void

    • If missing superuser permission, throw PermissionErr

      Parameters

      • action: string

      Returns void

    • Return an immutable thread safe object which will be passed thru the commit process and available via the FolioHooks callbacks. This is typically the User instance. HxContext always returns user.

      Returns JsObj

    • 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

    • In-memory folio database

      Returns ShellFolio

    • Dereference an id to an record dict or null if unresolved

      Parameters

      Returns Dict

    • 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

    • Evaluate an Axon expression within this context. Convenience for evalExpr(parse(src, loc))

      Parameters

      • src: string
      • Optionalloc: Loc

      Returns JsObj

    • Evaluate an expression

      Parameters

      Returns JsObj

    • Evaluate expression to a function expression

      Parameters

      • src: string

      Returns Fn

    • Find top-level function by qname or name

      Parameters

      • name: string
      • Optionalchecked: boolean

      Returns Fn

    • Map of installed functions

      Returns Map<string, TopFn>

    • Map of installed functions

      Parameters

      Returns void

    • 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 inference engine used for def aware filter queries

      Returns FilterInference

    • Flag to terminate the interactive loop

      Returns boolean

    • Flag to terminate the interactive loop

      Parameters

      • it: boolean

      Returns void

    • 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

    • Def namespace

      Returns Namespace

    • Standout output stream

      Returns OutStream

    • Standout output stream

      Parameters

      Returns void

    • Parse Axon expression

      Parameters

      • src: string
      • Optionalloc: Loc

      Returns Expr

    • Print the value to the stdout

      Parameters

      Returns void

    • Create Xeto printer for output stream

      Parameters

      Returns Printer

    • Parameters

      Returns File

    • Run the given expression and handle errors/output

      Parameters

      • expr: string

      Returns number

    • Run the iteractive prompt+eval loop

      Returns number

    • No session available

      Parameters

      • Optionalchecked: boolean

      Returns HxSession

    • Flag for full stack trace dumps

      Returns boolean

    • Flag for full stack trace dumps

      Parameters

      • it: boolean

      Returns void

    • Stash allows you to stash objects on the Context object during an Axon evaluation. You should scope your string keys with your pod name to avoid naming collisions.

      Returns Map<string, JsObj>

    • Return contextual data as dict

      Returns Dict

    • 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

    • Resolve dict by id - used by trap on Ref

      Parameters

      • id: Ref
      • Optionalchecked: boolean

      Returns Dict

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

      Returns Type

    • Current user

      Returns HxUser

    • 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

    • Read all the records with a given tag name/value pair

      Parameters

      Returns JsObj

    • Read a data record by id

      Parameters

      Returns Dict

    • 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

    • Sentinel value for no echo

      Returns string