@haxall/haxall
    Preparing search index...

    Class Diff

    Diff encapsulates a set of changes to apply to a record.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Changes applied to oldRec with resulting newRec

      Returns Dict

    • 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

    • Bitmask meta-data for diff

      Returns number

    • Get tag value from new record or null.

      Parameters

      • tag: string
      • Optionaldef: JsObj

      Returns JsObj

    • Get tag value from old record or null.

      Parameters

      • tag: string
      • Optionaldef: JsObj

      Returns JsObj

    • 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

    • Target record id

      Returns Ref

    • Flag indicating if adding a new record to the project

      Returns boolean

    • Flag indicating that changes should be applied regardless of other concurrent changes which may be been applied after the oldRec version was read.

      Returns boolean

    • 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

    • Flag indicating if remove an existing record from the project

      Returns boolean

    • Flag indicating that this diff should not be flushed to persistent storage (it may or may not be persisted).

      Returns boolean

    • Update diff - not an add nor a remove

      Returns boolean

    • Timestamp version of newRec or null

      Returns DateTime

    • Updated record which is null until after commit

      Returns Dict

    • Timestamp version of oldRec or null if adding new record

      Returns DateTime

    • Original record or null if adding new record

      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>

    • String representation

      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

    • Flag bitmask for isAdd

      Returns number

    • 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

    • Flag bitmask for isForce

      Returns number

    • Flag bitmask for force and transient

      Returns number

    • Construct a modfication for an existing record. The oldRec should be the instance which was read from the project. Any tags to add/set/remove should be included in the changes dict. Use haystack::Remove.val to indicate a tag should be removed. See makeAdd to create a Diff for adding a new record to a project.

      Parameters

      • oldRec: Dict
      • changes: JsObj
      • Optionalflags: number
      • ...args: unknown[]

      Returns Diff

    • Make a Diff to add a new record into the database.

      Parameters

      • changes: JsObj
      • Optionalid: Ref
      • ...args: unknown[]

      Returns Diff

    • Flag bitmask for isRemove

      Returns number

    • Flag bitmask for isTransient

      Returns number