Utility TypeScript @ 2.0.0-beta
    Preparing search index...

    Class NodeConsoleExperimental

    A configurable class for outputting to console within node.

    Includes formatting and interactive utilities.

    MessageMaker Used to format strings for output. Initialized in the constructor.

    0.1.1

    2.0.0-alpha — Prompters moved to a NodeConsole_Prompt property instead.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties - Aliases

    Properties - Args

    Properties - Interactive

    Properties - Utilities

    Accessors - Args

    Methods - Aliases

    Methods - Args

    Methods - Exporters

    Methods - Outputters

    Methods - Outputters (Pre-formatted)

    Methods - Static

    Methods - Terminal

    Constructors

    Properties - Aliases

    mergeArgs: {
        <D extends object>(
            defaults: D,
            inputs?: undefined,
            recursive?: boolean,
        ): D;
        <D extends object, I extends Partial<D>>(
            defaults: D,
            inputs: I,
            recursive?: false,
        ): D & I;
        <D extends object, I extends Partial<D> | RecursivePartial<D>>(
            defaults: D,
            inputs: I,
            recursive: true,
        ): D & I;
        <D extends object, I extends Partial<D> | RecursivePartial<D>>(
            defaults: D,
            inputs?: I,
            recursive?: boolean,
        ): D | D & I;
    } = mergeArgs

    An alias for this package's mergeArgs().

    Type declaration

      • <D extends object>(defaults: D, inputs?: undefined, recursive?: boolean): D
      • Inputs can be undefined, and if so, the default is returned.

        Type Parameters

        • D extends object

          Default object type.

        Parameters

        • defaults: D

          Default values (if not specified in inputs).

        • Optionalinputs: undefined

          Overriding values (changes to make).

        • Optionalrecursive: boolean

          Optional. Whether to merge the object recursively. Default false.

        Returns D

        Resulting object with all the defaults and inputs keys with either default values or input values, as appropriate.

      • <D extends object, I extends Partial<D>>(
            defaults: D,
            inputs: I,
            recursive?: false,
        ): D & I
      • Passing recursive as false means that the input type must be a Partial (not RecursivePartial).

        Type Parameters

        • D extends object
        • I extends Partial<D>

        Parameters

        • defaults: D
        • inputs: I
        • Optionalrecursive: false

        Returns D & I

      • <D extends object, I extends Partial<D> | RecursivePartial<D>>(
            defaults: D,
            inputs: I,
            recursive: true,
        ): D & I
      • Passing recursive as true means that the input type may actually be a RecursivePartial.

        Type Parameters

        Parameters

        • defaults: D
        • inputs: I
        • recursive: true

        Returns D & I

      • <D extends object, I extends Partial<D> | RecursivePartial<D>>(
            defaults: D,
            inputs?: I,
            recursive?: boolean,
        ): D | D & I
      • Universal overload.

        Type Parameters

        Parameters

        • defaults: D
        • Optionalinputs: I
        • Optionalrecursive: boolean

        Returns D | D & I

    Properties - Args

    A completed args object.

    Properties - Interactive

    Public alias for internal prompting methods.

    Properties - Utilities

    A local instance of MessageMaker initialized using {@link NodeConsole.Args}.msgMaker.

    Accessors - Args

    • get ARGS_DEFAULT(): {
          argsRecursive: true;
          msgMaker: { msg: { maxWidth: 100; tab: " " }; paintFormat: "node" };
          prompt: { throwError: "auto"; timeout: 300000 };
          separator: null;
          styleClrs: {
              disabled: "grey";
              error: "red";
              help: "grey";
              highlight: "purple";
          };
          varInspect: {};
      }
      Experimental

      Returns {
          argsRecursive: true;
          msgMaker: { msg: { maxWidth: 100; tab: " " }; paintFormat: "node" };
          prompt: { throwError: "auto"; timeout: 300000 };
          separator: null;
          styleClrs: {
              disabled: "grey";
              error: "red";
              help: "grey";
              highlight: "purple";
          };
          varInspect: {};
      }

    Methods - Aliases

    Methods - Args

    Methods - Exporters

    Methods - Outputters

    Methods - Outputters (Pre-formatted)

    Methods - Static

    Methods - Terminal

    • Experimental

      Runs given string as a terminal command, optional with arguments.

      Parameters

      • cmd: string

        Command to run in the terminal.

      • args: { [key: string]: null | string | number | boolean } = {}

        Optional. Passed to NodeConsole.cmdArgs. Default {}.

      • OptionalliteralFalse: boolean

        Optional. Passed to NodeConsole.cmdArgs. Default undefined.

      • Optionalequals: boolean

        Optional. Passed to NodeConsole.cmdArgs. Default undefined.

      Returns void

    • Experimental

      Formats an arguments object into a command-line string of arguments.

      Parameters

      • obj: { [key: string]: null | string | number | boolean }

        Arguments to translate.

      • literalFalse: boolean = false

        Optional. If true, false arguments are converted to --key=false. Otherwise false args are --no-key. Default false.

      • equals: boolean = true

        Optional. Whether argument keys should include an equals character (e.g., --key=false). Default true.

      Returns string