json

Signature

json(
  data: object,
  options?: {
    level?: ZylogOutputLevel;
    message?: string;
  }
): void

Description

The json method stringifies any JavaScript object into a pretty-printed JSON format (2-space indentation). This ensures that complex data structures are readable in the terminal and correctly formatted for file logs.

---

Examples

Logging a Payload

Standard usage for inspecting incoming data.

const user = { id: 1, name: 'Alice', roles: ['admin', 'editor'] };

zylog.json(user);

Critical Data Inspection

Override the log level to ensure critical object state is captured in error logs.

try {
  processData();
} catch (err) {
  zylog.json({ error: err.message, stack: err.stack }, 'error');
}

Using with Prefixes

Add context to your JSON dumps.

zylog.with({ prefix: 'CONFIG' }).json(process.env, 'debug');

Adding Context Message

Attach a message for better traceability.

zylog.json({ query: 'SELECT * FROM users' }, { message: 'Database querying' });

Error Inspection

Capture structured error details.

try {
  processData();
} catch (err) {
  zylog.json(
    { message: err.message, stack: err.stack },
    { level: 'error', message: 'Unhandled exception' },
  );
}