@shuota/variable-checker v0.2.0

Variable Checker

This is a simple test logger which you can use just like console.log() for checking your variables.

1. Install the package

npm i @shuota/variable-checker

2. Import to your file. and instantiate it

import VarChecker from "@shuota/variable-checker";
const myLogger = VarChecker.create();

3. .before({variable})

let num:number = 4 * 5

myLogger.before({num}) 
//output in console:
// [BEFORE] {
//      num: "20",
//  }

if you use .before({}), you will get [BEFORE] label in the console.
Don't forget to include {} inside ()

4. .after({variable})

num = 6 * 8
//update the `num` variable

myLogger.after({num})
//output in console:
// [AFTER] {
//      num: "48",
//   }

with .after({}), you will get [AFTER] label in the console.
same as above, please include {} inside ()

5. with function

Yes, you can use this package with function, but make sure you need to store your function to a variable.

function greeting(greet:string):string{
    return `${greet}, everyone!!`
}
let morningGreet = greeting('Good morning')

myLogger.before({morningGreet})
// output in console:
//  [BEFORE] {
//       morningGreet: "Good morning, everyone!!",
//  }

morningGreet = greeting('Hello')

myLogger.after({morningGreet})
// output in console:
//  [AFTER] {
//       morningGreet: "Hello, everyone!!",
//  }

6 Type of your variable

For each method/function in this package, you can put optional boolean value as second argument in order to display type of your variable in the console.
true : displays type
false : none

const myLogger = VarChecker.create();
let num = 3 * 5;
myLogger.before({num}, true)
//output in console:
//  [BEFORE] number {
//    num: 15,
//  }

num = 6 * 8
myLogger.after({num}, true)
// output in console: 
//   [AFTER] number {
//    num: 48,
//   }

7 TimeStamp

It displays the timestamp in the console if you put true as third argument which is also optional, the default value is false.

const myLogger = VarChecker.create();
let num = 4 * 5
myLogger.before({num}, false, true)
//output in console:
//  Fri Feb 09 2024 17:24:07 GMT-0800 (Pacific Standard Time) [BEFORE] {
//      num: 20,
//  }


num = 6 * 8
myLogger.after({num}, false, true)
// ouput in console:
//  Fri Feb 09 2024 17:24:07 GMT-0800 (Pacific Standard Time) [AFTER] {
//      num: 48,
//  }

Thank you for reading!