Class MessageMaker`Experimental`

A configurable class for formatting message strings for various outputs.

Since

0.1.1 — Experimental

Hierarchy (View Summary)

abstracts.AbstractConfigurableClass<MessageMaker.Args>
- MessageMaker

Index

Constructors

constructor

new MessageMaker(args?: RecursivePartial<MessageMaker.Args>): MessageMaker
Experimental
Parameters
- args: RecursivePartial<MessageMaker.Args> = {}
Returns MessageMaker
Overrides AbstractConfigurableClass.constructor
- Defined in classes/MessageMaker.ts:419

Properties - Aliases

`Function` `Experimental`mergeArgs

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
  - D extends object
  - I extends Partial<D> | RecursivePartial<D>
  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
  - D extends object
  - I extends Partial<D> | RecursivePartial<D>
  Parameters
  - defaults: D
  - Optionalinputs: I
  - Optionalrecursive: boolean
  Returns D | D & I

Properties - Args

`Readonly` `Experimental`args

args: MessageMaker.Args

A completed args object.

Accessors

ARGS_DEFAULT

get ARGS_DEFAULT(): {
    ansiColours: {
        "24": {
            black: "2;26;26;26";
            blue: "2;60;84;157";
            green: "2;24;118;10";
            grey: "2;108;108;108";
            "light-grey": "2;208;208;208";
            orange: "2;174;84;4";
            pink: "2;179;77;145";
            purple: "2;129;75;155";
            red: "2;168;36;36";
            turquoise: "2;0;128;98";
            white: "2;248;248;248";
            yellow: "2;204;182;0";
        };
        "4": {
            bg: {
                black: "40";
                blue: "44";
                green: "42";
                grey: "40";
                "light-grey": "47";
                orange: "43";
                pink: "45";
                purple: "45";
                red: "41";
                turquoise: "46";
                white: "47";
                yellow: "43";
            };
            fg: {
                black: "30";
                blue: "34";
                green: "32";
                grey: "30";
                "light-grey": "37";
                orange: "33";
                pink: "35";
                purple: "35";
                red: "31";
                turquoise: "36";
                white: "37";
                yellow: "33";
            };
        };
        "8": {
            black: "5;232";
            blue: "5;20";
            green: "5;28";
            grey: "5;241";
            "light-grey": "5;247";
            orange: "5;166";
            pink: "5;162";
            purple: "5;55";
            red: "5;124";
            turquoise: "5;30";
            white: "5;255";
            yellow: "5;208";
        };
    };
    argsRecursive: true;
    msg: {
        bold: false;
        clr: null;
        depth: 0;
        flag: false;
        fullWidth: false;
        hangingIndent: "";
        indent: "";
        italic: false;
        linesIn: 0;
        linesOut: 1;
        maxWidth: null;
        minWidth: 20;
        tab: " ";
    };
    painter: null;
    paintFormat: null;
    paintIfEmpty: false;
}
Experimental
Returns {
    ansiColours: {
        "24": {
            black: "2;26;26;26";
            blue: "2;60;84;157";
            green: "2;24;118;10";
            grey: "2;108;108;108";
            "light-grey": "2;208;208;208";
            orange: "2;174;84;4";
            pink: "2;179;77;145";
            purple: "2;129;75;155";
            red: "2;168;36;36";
            turquoise: "2;0;128;98";
            white: "2;248;248;248";
            yellow: "2;204;182;0";
        };
        "4": {
            bg: {
                black: "40";
                blue: "44";
                green: "42";
                grey: "40";
                "light-grey": "47";
                orange: "43";
                pink: "45";
                purple: "45";
                red: "41";
                turquoise: "46";
                white: "47";
                yellow: "43";
            };
            fg: {
                black: "30";
                blue: "34";
                green: "32";
                grey: "30";
                "light-grey": "37";
                orange: "33";
                pink: "35";
                purple: "35";
                red: "31";
                turquoise: "36";
                white: "37";
                yellow: "33";
            };
        };
        "8": {
            black: "5;232";
            blue: "5;20";
            green: "5;28";
            grey: "5;241";
            "light-grey": "5;247";
            orange: "5;166";
            pink: "5;162";
            purple: "5;55";
            red: "5;124";
            turquoise: "5;30";
            white: "5;255";
            yellow: "5;208";
        };
    };
    argsRecursive: true;
    msg: {
        bold: false;
        clr: null;
        depth: 0;
        flag: false;
        fullWidth: false;
        hangingIndent: "";
        indent: "";
        italic: false;
        linesIn: 0;
        linesOut: 1;
        maxWidth: null;
        minWidth: 20;
        tab: " ";
    };
    painter: null;
    paintFormat: null;
    paintIfEmpty: false;
}
Overrides AbstractConfigurableClass.ARGS_DEFAULT
- Defined in classes/MessageMaker.ts:245

Methods - Args

buildArgs

buildArgs(args?: RecursivePartial<MessageMaker.Args>): MessageMaker.Args
Experimental
Build a complete args object.
Parameters
- Optionalargs: RecursivePartial<MessageMaker.Args>
Returns MessageMaker.Args
Overrides AbstractConfigurableClass.buildArgs
- Defined in classes/MessageMaker.ts:353

msgArgs

msgArgs<InputArgs extends Partial<MessageMaker.MsgArgs>>(
args?: InputArgs,
): MessageMaker.MsgArgs & InputArgs
Experimental
Build a complete args object.
Type Parameters
- InputArgs extends Partial<MessageMaker.MsgArgs>
Parameters
- Optionalargs: InputArgs
Returns MessageMaker.MsgArgs & InputArgs
- Defined in classes/MessageMaker.ts:388

Methods - Exporters

toString

toString(): string
Experimental
Overrides the default function to return a string representation of this object.

Returns string
See
Object.prototype.toString()
Inherited from AbstractConfigurableClass.toString
- Defined in classes/abstracts/AbstractConfigurableClass.ts:100

Methods - Formatters

implodeWithIndent

implodeWithIndent(lines: (string | string[])[], indent?: string): string
Experimental
Joins string arrays with a single new line and adds an indent to the beginning of every line, and adds next level of indent for child arrays.
Parameters
- lines: (string | string[])[]
  String to implode. Arrays are joined with '\n'.
- indent: string = ...
  Optional. Default this.args.msg.tab.
Returns string
The same text, but with an indent added after every new line.
- Defined in classes/MessageMaker.ts:439

Methods - Messagers

msg

msg(msg: string | string[], _args?: Partial<MessageMaker.MsgArgs>): string
Experimental
Formats the given message according to options.
Parameters
- msg: string | string[]
  Message to display. If it's an array, the strings are joined with '\n'.
- _args: Partial<MessageMaker.MsgArgs> = {}
  Optional. Overrides for default arguments in MessageMaker.args.
Returns string
- Defined in classes/MessageMaker.ts:507

msgs

msgs(messages: BulkMsgs, universalArgs?: Partial<BulkMsgArgs>): string
Experimental
Formats given messages individually and then joins them on return.
Parameters
- messages: BulkMsgs
  Messages to display, each with their own personal override arguments. Joined with universalArgs.joiner (default '\n\n') before return.
- universalArgs: Partial<BulkMsgArgs> = {}
  Optional. Overrides for default arguments in MessageMaker.args for all messages.
Returns string
- Defined in classes/MessageMaker.ts:551

timestampMsg

timestampMsg(
    msg: string | string[] | BulkMsgs,
    msgArgs?: RecursivePartial<BulkMsgArgs>,
    timeArgs?: Partial<MessageMaker.MsgArgs> & Partial<
        { date: Date; stamp: Args_Input },
    >,
): string
Experimental
Formats the given message according to options.
Parameters
- msg: string | string[] | BulkMsgs
  Message to display. If it's an array, the strings are joined with '\n'.
- msgArgs: RecursivePartial<BulkMsgArgs> = {}
  Optional. Overrides for default arguments in ['msgArgs']. Used for the whole message.
- timeArgs: Partial<MessageMaker.MsgArgs> & Partial<{ date: Date; stamp: Args_Input }> = {}
  Optional. Overrides for default arguments in ['msgArgs']. Used only for the timestamp.
Returns string
- Defined in classes/MessageMaker.ts:632

`Protected`lineMapper

lineMapper(line: string, args: MessageMaker.MsgArgs, prefix?: string): string
Experimental
Used to map each line of a message in MessageMaker.msg.

Does not wrap or split it (assumes this has already been done). Applies MessageMaker.painter and MessageMaker.Args.depth indent.
Parameters
- line: string
  String to map. Already wrapped to line width, if applicable.
- args: MessageMaker.MsgArgs
  Message arguments that apply to this line. Also passed to MessageMaker.painter.
- prefix: string = ''
  Optional. Unpainted string added before the line. Helpful for hanging indents. Default ''.
Returns string
- Defined in classes/MessageMaker.ts:475

Methods - Static

`Protected` `Static`defaultPainter

defaultPainter(
classArgs: MessageMaker.Args,
): null | ((line: string, args?: Partial<PainterArgs>) => string)
Experimental
Returns the default painter callback function for the given format.

'html' and 'markdown' default painters currently do not apply any colours.

Used only by MessageMaker.buildArgs.
Parameters
- classArgs: MessageMaker.Args
  A complete arguments object. Requires complete to avoid building complete arguments multiple times.
Returns null | ((line: string, args?: Partial<PainterArgs>) => string)
- Defined in classes/MessageMaker.ts:50

Methods - Stylers

painter

painter(msg: string, args?: Partial<PainterArgs>): string
Experimental
Applies colour and font styles to an message for output.
Parameters
- msg: string
- args: Partial<PainterArgs> = {}
Returns string
- Defined in classes/MessageMaker.ts:603

Class MessageMakerExperimental

Since

Hierarchy (View Summary)

Index

Constructors

Properties - Aliases

Properties - Args

Accessors

Methods - Args

Methods - Exporters

Methods - Formatters

Methods - Messagers

Methods - Static

Methods - Stylers

Constructors

constructor

Parameters

Returns MessageMaker

Properties - Aliases

Function ExperimentalmergeArgs

Type declaration

Type Parameters

Parameters

Returns D

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D | D & I

Properties - Args

Readonly Experimentalargs

Accessors

ARGS_DEFAULT

Methods - Args

buildArgs

Parameters

Returns MessageMaker.Args

msgArgs

Type Parameters

Parameters

Returns MessageMaker.MsgArgs & InputArgs

Methods - Exporters

toString

Returns string

See

Methods - Formatters

implodeWithIndent

Parameters

Returns string

Methods - Messagers

msg

Parameters

Returns string

msgs

Parameters

Returns string

timestampMsg

Parameters

Returns string

ProtectedlineMapper

Parameters

Returns string

Methods - Static

Protected StaticdefaultPainter

Parameters

Returns null | ((line: string, args?: Partial<PainterArgs>) => string)

Methods - Stylers

painter

Parameters

Returns string

Settings

On This Page

Class MessageMaker`Experimental`

`Function` `Experimental`mergeArgs

`Readonly` `Experimental`args

`Protected`lineMapper

`Protected` `Static`defaultPainter