@rahul1711/utils v1.0.7

Node.js Utilities

Node.js development utilities for printing data to terminal.

Install

npm install @rahul1711/utils

Usage

Load the package

const utils = require('@rahul1711/utils');

Configure

Configure the global options.

utils.configure([options]);

• options (1)
• options (2)
• options (3)

Get a line

Create a line using the character provided.

utils.getLine([options]);

• options: <Array> These options override the same options provided in utils.configure
  • char: <char> A character to use for printing the line. Default: -
  • len: <integer> Length of the line. Default: 67

Print a line

Print a line returned from utils.getLine.

utils.line([options]);

• options

Get a string

Format the object using the built in util.inspect method.

utils.getString(obj[, option]);

• options (override options of the built in util.inspect method)

Log

Print a string returned from utils.getString.

utils.log(obj[, options]);

• options

Log with lines

Wrap utils.log with lines.

utils.line is used to print the lines.

utils.logC(obj[, options]);

• options (1)
• options (2)

Get a JSON string

Format the object using the built in JSON.stringify method.

utils.getJsonString(obj[, options]);

• options: <Array> These options override the same options provided in utils.configure
  • replacer: <function> A map function for object properties. Default
  • indent: <integer> | <string> A string or number used to add whitespace in the returned string. Default:4
  • removeQuotes: <boolean> Remove quotes from the keys. Default:true
  • singleLineArray: <boolean> Print an array in a single line. Default:true

Log using JSON method

Print a string returned from utils.getJsonString.

utils.json(obj[, options]);

• options

Log with lines using JSON method

Wrap utils.json with lines.

utils.line is used to print the lines.

utils.jsonC(obj[, options]);

• options (1)
• options (2)

Samples

Sample files can be found in /samples directory.

Notes

• Options passed in utils.configure are global, and will be used whenever options are not passed to any methods.
• Passing options to any method other than utils.configure will be valid for that function call only.