@haxall/haxall
    Preparing search index...

    Class LibAbstract

    Versioned library module of specs and defs.

    Lib dict representation:

    • id: Ref "lib:{name}"
    • spec: Ref "sys::Lib"
    • loaded: marker tag if loaded into memory
    • meta

    Hierarchy (View Summary)

    Implements

    Implemented by

    Index

    Constructors

    constructor

    Properties

    type$

    Methods

    _id compare depends each eachWhile equals files get global globals has hash instance instances isEmpty isImmutable map meta metaSpec metaSpecs missing name spec specs toImmutable toStr trap type typeof types version with echo

    Constructors

    Properties

    type$: Type

    Methods

    _id

    • _id(): Ref

      Return "lib:{name}" as identifier This is a temp shim until we move haystack::Dict fully into Xeto.

      Returns Ref

    • 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

    • List the dependencies

      Returns List<LibDepend>

    • Iterate through the name/value pairs

      Parameters

      • f: (arg0: JsObj, arg1: string) => void

      Returns void

    • Iterate through the name/value pairs until the given function returns non-null, then break the iteration and return resulting object. Return null if function returns null for every name/value pair.

      Parameters

      Returns JsObj

    • 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

    • Access all the resource files contained by this library. Resources are any files included in the libs's zip file excluding xeto files. This API is only available in server environments.

      Returns LibFiles

    • Get the value for the given name or def if name not mapped

      Parameters

      • name: string
      • Optionaldef: JsObj

      Returns JsObj

    • Lookup a top level global slot spec in this library by simple name

      Parameters

      • name: string
      • Optionalchecked: boolean

      Returns Spec

    • List the top level global slots

      Returns List<Spec>

    • Return true if this dictionary contains given name

      Parameters

      • name: string

      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

    • Lookup an instance dict by its simple name

      Parameters

      • name: string
      • Optionalchecked: boolean

      Returns Dict

    • List the instance data dicts declared in this library

      Returns List<Dict>

    • Return if the there are no name/value pairs

      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

    • Create a new instance of this dict with the same names, but apply the specified closure to generate new values.

      Parameters

      Returns this

    • Meta data for library

      Returns Dict

    • Lookup a top level meta spec in this library by simple name

      Parameters

      • name: string
      • Optionalchecked: boolean

      Returns Spec

    • List the top level meta specs

      Returns List<Spec>

    • Return true if this dictionary does not contain given name

      Parameters

      • name: string

      Returns boolean

    • Dotted name of the library

      Returns string

    • Lookup a top level spec in this library by simple name (type or global slot)

      Parameters

      • name: string
      • Optionalchecked: boolean

      Returns Spec

    • List the top level specs (types and global slots)

      Returns List<Spec>

    • 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

    • Get the value mapped by the given name. If it is not mapped to a non-null value, then throw an UnknownNameErr.

      Parameters

      Returns JsObj

    • Lookup a top level type spec in this library by simple name

      Parameters

      • name: string
      • Optionalchecked: boolean

      Returns Spec

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

      Returns Type

    • List the top level types

      Returns List<Spec>

    • Version of this library

      Returns Version

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods