Getting Started

Install ZTracer and write your first log in minutes.

On this page

Requirements

Installation

npm install z-tracer-kit

Also available via yarn add z-tracer-kit or pnpm add z-tracer-kit.

ES Module (ESM) Usage

If your project uses "type": "module" in package.json or .mjs files: 

import ZTracer from "z-tracer-kit";

const logger = new ZTracer({ global: { debug: true } });
await logger.log("Hello from ESM!");

CommonJS (CJS) Usage

If your project uses "type": "commonjs" in package.json or .cjs files: 

const { ZTracer } = require("z-tracer-kit");

const logger = new ZTracer({ global: { debug: true } });
await logger.log("Hello from CommonJS!");
Note: ZTracer exports ZTracer as both the default and a named export. In CommonJS, you can use const { ZTracer } = require('z-tracer-kit') or const ZTracer = require('z-tracer-kit').default.

Browser Usage

In the browser, you can use an import map or a bundler: 

<script type="importmap">
{
  "imports": {
    "z-tracer-kit": "./node_modules/z-tracer-kit/dist/esm/index.js"
  }
}
</script>
<script type="module">
  import ZTracer from "z-tracer-kit";
  const logger = new ZTracer({ global: { debug: true } });
  await logger.log("Hello from the browser!");
</script>

For a complete example, see the Examples page.

Next Steps