Class MessageMakerExperimental

constructor

• new MessageMaker(args?: RecursivePartial<MessageMaker.Args>): MessageMaker
  Experimental

  Parameters

  • args: RecursivePartial<MessageMaker.Args> = {}

  Returns MessageMaker

Readonly Experimentalargs

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";
          };
      };
      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

  Default arguments.

  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";
          };
      };
      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;
  }

buildArgs

• buildArgs(args?: RecursivePartial<MessageMaker.Args>): MessageMaker.Args
  Experimental

  Build a complete args object.

  Parameters

  • Optionalargs: RecursivePartial<MessageMaker.Args>

  Returns MessageMaker.Args

bulk

• bulk(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

  Since

  2.0.0-beta.3 — Renamed from msgs to bulk.

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.

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

msgArgs

• msgArgs<InputArgs extends Partial<MessageMaker.MsgArgs>>(
      args?: InputArgs,
  ): MessageMaker.MsgArgs & InputArgs
  Experimental

  Build a complete MessageMaker.MsgArgs object.

  Type Parameters

  • InputArgs extends Partial<MessageMaker.MsgArgs>

  Parameters

  • Optionalargs: InputArgs

  Returns MessageMaker.MsgArgs & InputArgs

normalizeBulkInput

• normalizeBulkInput(msg: string | string[] | BulkMsgs): BulkMsgs
  Experimental

  Normalizes any input into bulk input.

  Parameters

  • msg: string | string[] | BulkMsgs

  Returns BulkMsgs

  Since

  2.0.0-beta.3

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

timestamp

• timestamp(
      date?: Date | null,
      args?: Partial<timestamp.Args> | RecursivePartial<timestamp.Args>,
  ): string
  Experimental

  Formats a timestamp according to the args.

  Parameters

  • date: Date | null = null
  • args: Partial<timestamp.Args> | RecursivePartial<timestamp.Args> = {}

  Returns string

  Since

  2.0.0-beta.3

timestamped

• timestamped(
      msg: string | string[] | BulkMsgs,
      msgArgs?: RecursivePartial<TimestampedArgs>,
  ): string
  Experimental

  Formats a message prepended with a timestamp.

  Parameters

  • msg: string | string[] | BulkMsgs

    Message to display. If it's an array, the strings are joined with '\n'.

  • msgArgs: RecursivePartial<TimestampedArgs> = {}

    Optional. Overrides for default arguments in MessageMaker.msgArgs.

  Returns string

  Since

  2.0.0-beta.3 — Renamed from timestampMsg to timestamped. Removed timeArgs param and switched to a time prop in msgArgs.