@haxall/haxall
    Preparing search index...

    Class HaystackFuncs

    Haystack connector functions

    Hierarchy (View Summary)

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

    • 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

    • Perform Haystack HTTP API call to given Str op name and with given request grid (can be anything acceptable toGrid). If the checked flag is true and server returns an error grid, then raise haystack::CallErr, otherwise return the grid itself. Result is returned as Grid. Also see haystack::Client.call.

      Parameters

      • conn: JsObj
      • op: string
      • Optionalreq: JsObj
      • Optionalchecked: boolean

      Returns Grid

    • Evaluate an Axon expression in a remote server over a haystack connector. The remote server must be a SkySpark server which supports the "eval" REST op with an Axon expression. This function blocks while the network request is made. The result is always returned as a Grid using the same rules as haystack::Etc.toGrid.

      The expression to evaluate in the remote server may capture variables from the local scope. If these variables are atomic types, then they are captured as defined by local scope and serialized to the remote server. Pass {debug} for opts to dump to stdout the actual expr with serialized scope.

      Options:

      • debug: dumps full expr with seralized scope to stdout
      • evalTimeout: duration number to override remote project's default evalTimeout

      Examples:

      read(haystackConn).haystackEval(3 + 4)
      read(haystackConn).haystackEval(readAll(site))
      read(haystackConn).haystackEval(readAll(kw).hisRead(yesterday))

      Parameters

      Returns JsObj

    • Perform Haystack REST API "hisRead" call to read history data for the record identified by the id (must be Ref). The range is any string encoding supported by the REST API or any value supported by toDateSpan. Return results as grid with "ts" and "val" column.

      Parameters

      Returns Grid

    • Invoke a remote action on the given Haystack connector and remote entity. The id must be a Ref of the remote entity's identifier and action is a Str action name. If args are specified, then they should be a Dict keyed by parameter name.

      Parameters

      Returns JsObj

    • Deprecated - use connLearn()

      Parameters

      Returns Grid

    • Deprecated - use connPing()

      Parameters

      Returns Future

    • Perform Haystack REST API call to read single entity with filter. The filter is an expression like readAll. Return result as dict. If the record is not found, then return null or raise UnknownRecErr based on checked flag. Also see haystack::Client.read.

      Parameters

      Returns Dict

    • Perform Haystack REST API call to read all entities with filter. The filter is an expression like readAll. Return results as grid. Also see haystack::Client.readAll.

      Parameters

      Returns Grid

    • Perform Haystack HTTP API call to read a record by its unique identifier. Return result as dict. If the record is not found, then return null or raise UnknownRecErr based on checked flag. Also see haystack::Client.readById.

      Parameters

      Returns Dict

    • Perform Haystack HTTP API call to read a list of records by their identifiers. Return a grid where each row of the grid maps to the respective id list (indexes line up). If checked is true and any one of the ids cannot be resolved then raise UnknownRecErr for first id not resolved. If checked is false, then each id not found has a row where every cell is null. Also see haystack::Client.readByIds.

      Parameters

      Returns Grid

    • Deprecated - use connSyncHis()

      Parameters

      Returns JsObj

    • Parameters

      • ...args: unknown[]

      Returns HaystackFuncs