index.js

///══════════════════════════════════════════════════════════════════════════════
// ■ Inspect (inspect/index.js)
//┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈
//     Pretty string representation of object.
//══════════════════════════════════════════════════════════════════════════════
const stringify = require("./inspect/stringify");
const { check } = require("./inspect/utils");

//──────────────────────────────────────────────────────────────────────────────
// ● Inspect
//──────────────────────────────────────────────────────────────────────────────
function inspect(obj, options = {}) {
  check.assert.maybe.object(options);
  const { depth = 10 } = options;
  return stringify(obj, { depth });
}
inspect.inspect = inspect;

//──────────────────────────────────────────────────────────────────────────────
// ● Log
//──────────────────────────────────────────────────────────────────────────────
inspect.log = function log(obj, options = {}) {
  console.log(inspect(obj, options));
}

//──────────────────────────────────────────────────────────────────────────────
// ► Exports
//──────────────────────────────────────────────────────────────────────────────
module.exports = inspect;