console-log-it

console-log-it

Console log colors, boxes, and more for the browser and terminal

Version: 0.0.3

Summary of Utils

Click on each function name for details and examples

function	Description
logBox	Log out a message in a box
logDebug	Log out args based on a condition
logError	Log out an error message
logInfo	Log out an info message
logStatus	Log out a custom status message
logStyle	Log out a styled message
logSuccess	Log out a success message
logWarning	Log out a warning message

---

Examples

Here are some examples of things you can do with console-log-it:

Boxes

Core & Custom Statuses

Change Your Line Style

Interfaces & Types

These are importable if you are using TypeScript. If you're not using TypeScript, you can simply use these as a reference to the shapes of the objects and the potential values to pass into the functions.

export type Color = 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white';
export type BackgroundColor = 'bgBlack' | 'bgRed' | 'bgGreen' | 'bgYellow' | 'bgBlue' | 'bgMagenta' | 'bgCyan' | 'bgWhite';
export type Style = 'blink' | 'bright' | 'dim' | 'hidden' | 'reverse' | 'reset' | 'underscore';

export type LogBoxConfig = {
  color: Color,
  indent?: number,
  padding?: number,
  bufferLines?: boolean,
  symbol?: string,
};

export type LogBoxLine = {
  color: Color,
  message: string,
};

export type StatusConfig = {
  indent?: number,
  tagMessage?: string,
};

export type CustomStatusConfig = {
  indent?: number,
  tagColor: Color,
  tagMessage: string,
};

Package Contents

Within the module you'll find the following directories and files:

package.json
CHANGELOG.md -- history of changes to the module
README.md -- this file
/lib
  └───/es5
      └───index.d.ts - 430 Bytes
      └───index.js - 1.48 KB
    └───/logBox
      └───index.d.ts - 1.33 KB
      └───index.js - 4.87 KB
    └───/logDebug
      └───index.d.ts - 519 Bytes
      └───index.js - 806 Bytes
    └───/logError
      └───index.d.ts - 558 Bytes
      └───index.js - 1.12 KB
    └───/logInfo
      └───index.d.ts - 560 Bytes
      └───index.js - 1.12 KB
    └───/logStatus
      └───index.d.ts - 760 Bytes
      └───index.js - 1.61 KB
    └───/logStyle
      └───index.d.ts - 926 Bytes
      └───index.js - 1.63 KB
    └───/logSuccess
      └───index.d.ts - 548 Bytes
      └───index.js - 1.12 KB
    └───/logWarning
      └───index.d.ts - 557 Bytes
      └───index.js - 1.13 KB
    └───/types
      └───index.d.ts - 789 Bytes
      └───index.js - 79 Bytes
    └───/_private
      └───index.d.ts - 398 Bytes
      └───index.js - 2.14 KB
  └───/es6
      └───index.d.ts - 430 Bytes
      └───index.js - 324 Bytes
    └───/logBox
      └───index.d.ts - 1.33 KB
      └───index.js - 4.73 KB
    └───/logDebug
      └───index.d.ts - 519 Bytes
      └───index.js - 676 Bytes
    └───/logError
      └───index.d.ts - 558 Bytes
      └───index.js - 1000 Bytes
    └───/logInfo
      └───index.d.ts - 560 Bytes
      └───index.js - 1002 Bytes
    └───/logStatus
      └───index.d.ts - 760 Bytes
      └───index.js - 1.47 KB
    └───/logStyle
      └───index.d.ts - 926 Bytes
      └───index.js - 1.49 KB
    └───/logSuccess
      └───index.d.ts - 548 Bytes
      └───index.js - 994 Bytes
    └───/logWarning
      └───index.d.ts - 557 Bytes
      └───index.js - 1004 Bytes
    └───/types
      └───index.d.ts - 789 Bytes
      └───index.js - 12 Bytes
    └───/_private
      └───index.d.ts - 398 Bytes
      └───index.js - 1.91 KB

License

MIT

Author

Michael Paravano

Dependencies

None

Changelog

[0.0.3] - 2021-01-14

• Changed logBox to accept rest args for lines instead of string or array
• Updated documentation