Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/subsystem/system.info.options"

Index

Functions

checkOptionsFailure

  • checkOptionsFailure(options: SystemOptions): boolean
  • Checks options argument for missing incorrect property types

    example
    Usage var options = { id: "stars", rootDir: "test", relativeInitDir: "stars", initFilename: "stars.yml", logging: "off" };

    if (System.checkOptionsFailure(options)){ throw new Error ("Options inconsistent."); }

    Parameters

    • options: SystemOptions

      System options argument

    Returns boolean

    Returns true if the arguments is corrupt; false if OK

Generated using TypeDoc