Installing Adze

Install the Package

You can install Adze from NPM using the following command:

# npm
npm i -S adze

#pnpm
pnpm add adze

# Yarn
yarn add adze

Version Requirements

Dependency	Supported Versions	Notes
node	>= 18.19.x	When running Adze in a Node environment.
bun	>= 1.1.x	When running in a Bun environment.
deno	>= 1.46.x	When running in a Deno environment.
typescript	>= 5.5.x	When using Adze with TypeScript

TypeScript Configuration

Adze is built to be used with TypeScript and we highly encourage using it in this way.

When building your project with TypeScript, you need to make sure you use the "DOM" lib because Adze supports both the web browser and Node. Also, to support the dependencies of Adze, you'll need to add "esModuleInterop": true to your tsconfig as well.

For more information about configuring TypeScript, go to https://www.typescriptlang.org/docs/handbook/tsconfig-json.html.

Example

{
  "compilerOptions": {
    // ...your other options
    "lib": ["DOM"],
    "esModuleInterop": true
  }
}

Importing Adze

Adze comes bundled with a few different ways of accessing it. Here are some examples:

CommonJS

const { adze } = require('adze'); // Or alternatively `const adze = require('adze').adze;`

adze.log('Hello World!');

ESM / TypeScript

import adze from 'adze';

adze.log('Hello World!');

Line Numbers / Blackboxing

Although Adze is meant primarily for long-lived logs that should be in production environments you can use it for debugging purposes just like the standard console API. The caveat with using it for debugging is that you will need to enable Blackboxing.

A common problem with libraries that wrap the standard console API is that they lose line numbers in the browser console. This occurs because the browser console is reporting the line number at which the console API was called, which is usually within the library wrapper. To get around this problem, Chromium based browsers (like Chrome, Edge and Brave) added the Ignore List concept. This tells the browser to pretend like the library source code doesn't exist. This enables Adze logs to print correct line numbers from where they are called.

TIP

For information on setting up an Ignore List, please go to https://bit.ly/3d1eOex.

To ignore the adze library you will need to supply the following regular expression:

/\b(?:log|json|formatter)\b\.js/g;

For non-chromium based browsers, right now there is no easy way to work around this issue. We suggest using the standard console API for debugging purposes where line numbers are important and reserving Adze logs for long-lived logs that will be used in production environments.