Getting Started

Installation

yarn add dumpkit
# or
npm install dumpkit

Basic Usage

Import what you need

import { dump, dd, inspect, trace, measure } from 'dumpkit';

Dump a value

const user = { name: 'John', age: 30, tags: ['admin', 'user'] };

dump(user);

Output:

{
  name: "John",
  age: 30,
  tags: ["admin", "user"]
}

Dump and die

dd(user); // Dumps the value and terminates the process

Get formatted string without printing

const output = inspect(user);
console.log('Debug:', output);

Trace execution flow

function authenticate() {
  trace('auth-user');
  // ... authentication logic
}

authenticate();

Output:

[Trace] auth-user at src/auth.ts:42:12

Measure performance

// Synchronous
measure('sort-array', () => {
  return array.sort();
});

// Asynchronous
await measure('db-query', async () => {
  return await database.find({ id: 1 });
});

Output:

[Measure] sort-array: 2.35ms
[Measure] db-query: 45.23ms

Next Steps

• Check the API Reference for detailed options
• See Examples for advanced usage
• Read about the Philosophy behind dumpkit