Skip to content

Latest commit

 

History

History
123 lines (90 loc) · 2.53 KB

README.md

File metadata and controls

123 lines (90 loc) · 2.53 KB

npm version

Why JS.inspect()?

JS.inspect was made to help inspect objects, strings, sql queries in any system that runs javascript when Debug is not available or is too much intrusive.

  • React Native
  • browser
  • Nodejs
  • NativeScript

Demo

JS.inspect Demo

How to install?

yarn global add js.inspect 
npm i -g js.inspect

Usage

make a folder somewhere in your machine

mkdir inspect
cd inspect
touch index.js package.json
  1. put in package.json file this:
{
  "name": "inspect",
  "version": "1.0.0",
  "main": "index.js",
  "license": "MIT"
}
  1. put in index.js file this content:
const mkBody = (socket_id, title, obj, sql) => ({
  socket_id,
  title,
  lang: (sql ? "sql" : ""),
  obj,
});

const inspect = (id, title, obj, sql = false) => {
  const body = mkBody(id, title, obj, sql);
  fetch("http://{your_machine_ip}:8080/inspect", {
    method: "POST",
    headers: {'Content-Type': 'application/json'},
    body: JSON.stringify(body)
  });
  return false;
}

module.exports = inspect;
  1. replace {your_machine_ip} by your IP address, save the file.

  2. still in same folder that has index.js, run:

yarn link
  1. to use in another project, inside its folder, run:
yarn link inspect
  1. if the project is React Native, usage:
  require("inspect")("{ID}", "title", obj);
  1. if the project is Node, usage:
yarn add node-fetch
  const fetch = require("node-fetch");
  require("inspect")("{ID}", "title", obj);

Exemples

An object like this

  const obj = [
    {"id": 1, "name": "AAAAA"},
    {"id": 2, "name": "BBBBBB"},
    {"id": 3, "name": "CCCCCCC"},
    {"id": 4, "name": "DDDDDDD", "age": 20 },
    {"id": 4, "age": 33 }
  ];

  require("inspect")("04DF2iK4ghiAjqtaAAAA", "Random Object List", obj);

Will be represented as

Result 01

String SQL Query

  const query = "select id, name, age from table_name where id > 5 and id < 9";
  require("inspect")("04DF2iK4ghiAjqtaAAAA", "SQL formatted", query, true);

will be represented as

Result 02

Demo YouTube