Experimental
Function
Experimental
mergeAn alias for this package's mergeArgs().
Inputs can be undefined, and if so, the default is returned.
Default object type.
Default values (if not specified in inputs).
Optional
inputs: undefinedOverriding values (changes to make).
Optional
recursive: booleanOptional. Whether to merge the object recursively. Default false.
Resulting object with all the defaults
and inputs
keys with
either default values or input values, as appropriate.
Passing recursive
as false means that the input type must be a Partial
(not RecursivePartial).
Optional
recursive: falsePassing recursive
as true means that the input type may actually be a
RecursivePartial.
Universal overload.
Optional
inputs: IOptional
recursive: booleanReadonly
Experimental
msgA local instance of MessageMaker initialized using
{@link NodeConsole.Args}.msgMaker
.
Experimental
Experimental
Gets the maxWidth
from NodeConsole.args, or default (120
) if
none is set.
Experimental
Alias for NodeConsole.log with via: "debug"
argument.
Experimental
Alias for NodeConsole.logs with via: "debug"
argument.
Experimental
Alias for NodeConsole.separator.
Experimental
Alias for NodeConsole.log with via: "warn"
argument.
Experimental
Alias for NodeConsole.logs with via: "warn"
argument.
Experimental
Build a complete args object.
Optional
args: RecursivePartial<node.NodeConsole.Args>Experimental
Overrides the default function to return a string representation of this object.
Experimental
Outputs the given message to the console.
MessageMaker.msg Used to format the message.
Experimental
Outputs the given message to the console.
MessageMaker.msg Used to format the message.
Experimental
Outputs the given message to the console prefixed with a timestamp.
Message to display. If it's an array, the strings are joined with '\n'
.
Optional. Overrides for default message arguments. Used for the whole message.
Optional. Overrides for default message arguments. Used only for the timestamp.
MessageMaker.timestampMsg Used to format the message.
Experimental
Outputs the given message to the console prefixed with a timestamp.
Experimental
Outputs an inspection of the given variable to the console.
Experimental
Outputs a level-one heading string to the console.
Alias for MessageMaker.heading.
Experimental
Outputs a level-two heading string to the console.
Alias for MessageMaker.heading.
Experimental
Outputs a level-three heading string to the console.
Alias for MessageMaker.heading.
Experimental
Outputs a heading string to the console.
MessageMaker.msg Used to format the message.
Experimental
Outputs a separator string to the console.
MessageMaker.msg Used to format the message.
Static
sampleExperimental
Prints sample output to the console via NodeConsole.log().
An example, constructed instance used for the sample.
Static
sampleExperimental
Samples the interactive methods.
Optional
nc: node.NodeConsoleExperimental
Runs given string as a terminal command, optional with arguments.
Command to run in the terminal.
Optional. Passed to NodeConsole.cmdArgs. Default {}
.
Optional
literalFalse: booleanOptional. Passed to NodeConsole.cmdArgs. Default undefined
.
Optional
equals: booleanOptional. Passed to NodeConsole.cmdArgs. Default undefined
.
Experimental
Formats an arguments object into a command-line string of arguments.
Arguments to translate.
Optional. If true, false arguments are converted to
--key=false
. Otherwise false args are --no-key
.
Default false.
Optional. Whether argument keys should include an
equals character (e.g., --key=false
). Default true.
A configurable class for outputting to console within node.
Includes formatting and interactive utilities.
See
MessageMaker Used to format strings for output. Initialized in the constructor.
Since
0.1.1
Since
2.0.0-alpha — Prompters moved to a NodeConsole_Prompt property instead.