@haxall/haxall
    Preparing search index...

    Class Command

    Command implements a top-level command in the fanr command line tool.

    Commands declare their options using the CommandOpt facet which works similiar to util::AbstractMain. If the field is a Bool, then the option is treated as a flag option. Otherwise it must be one of these types: Str, Uri.

    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

    • Ask for y/n confirmation or skip if -y option specified.

      Parameters

      • msg: string

      Returns boolean

    • Get the local environment to use this command

      Returns FanrEnv

    • 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

    • Throw an exception which may be used to unwind the stack back to main to indicate command failed and return non-zero

      Parameters

      • msg: string
      • Optionalcause: Err

      Returns Err

    • Option to dump full stack trace on errors

      Returns boolean

    • Option to dump full stack trace on errors

      Parameters

      • it: boolean

      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 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

    • Name of command

      Returns string

    • Stdout for printing command output

      Returns OutStream

    • Stdout for printing command output

      Parameters

      Returns void

    • Password for authentication

      Returns string

    • Password for authentication

      Parameters

      • it: string

      Returns void

    • Get the repo to use for this command:

      • default is config prop "repo"
      • override with "-r" option

      Returns Repo

    • Repository URI -r option

      Returns Uri

    • Repository URI -r option

      Parameters

      Returns void

    • Execute command. If there is a failure then throw err, otherwise the command is assumed to be successful.

      Returns void

    • Option to skip confirmation (auto yes)

      Returns boolean

    • Option to skip confirmation (auto yes)

      Parameters

      • it: boolean

      Returns void

    • Short summary of command for usage screen

      Returns string

    • 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

    • Print usage to given output stream

      Parameters

      Returns void

    • Username for authentication

      Returns string

    • Username for authentication

      Parameters

      • it: string

      Returns void

    • Log a warning to out

      Parameters

      • msg: string

      Returns void

    • 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

    • Parameters

      • ...args: unknown[]

      Returns Command