pretty.dump v0.0.1

Pretty Dump

Provides a better dump function to visualize data in the terminal.

TOC

• Installation
• Basic Usage
• Examples
  • String
  • Number
  • Boolean
  • Null
  • Undefined
  • Array
  • Object
  • Function
  • Class
• Methods
  • dump()
  • dd()
• Author

Installation

    npm install pretty.dump

Basic Usage

    let pretty = require("pretty.dump");
    
    let variable = "string";

    pretty.dump(variable); // ==> "string"

Examples

String

    let variable = "string";

    pretty.dump(variable);

Number

    let variable = 123;

    pretty.dump(variable);

Boolean

    let variable = true;

    pretty.dump(variable);

Null

    let variable = null;

    pretty.dump(variable);

Undefined

    let variable = undefined;

    pretty.dump(variable);

Array

    let variable = ["a", "b", ["c", "d"]];

    pretty.dump(variable);

Object

    let variable = {
        name: "PrettyDump",
        status: "active"
    };

    pretty.dump(variable);

Function

    let variable = (a) => {
        return a*a;
    };

    pretty.dump(variable);

Class

    let variable = pretty;

    pretty.dump(variable);

In case of circular relationships, PrettyDump will print [Circular].

Methods

dump()

Prettyfies and dumps the variable to the console.

Example

    let variable = false;

    pretty.dump(variable); // ==> false

dd()

A.k.a. Die and dump. It prettyfies, dumps the variable to the console and exits the process.

Example

    let variable = ["a", "b"];

    pretty.dump(variable); // ==> array:2 [ 0: "a" 1: "b"]

Author

• Olavo Amorim Santos