@types/debug

What is @types/debug?

The @types/debug package provides TypeScript type definitions for the debug library, which is a JavaScript utility that helps you with debugging your code. It allows you to create a minimal and customizable debugging utility. The @types/debug package itself does not contain functionality but provides type support for TypeScript users of the debug library.

What are @types/debug's main functionalities?

Creating a debug instance

This code sample demonstrates how to import the debug module and create a debug instance. You can replace 'myNamespace' with a namespace string that is relevant to your application or module. This instance can then be used to log messages under that namespace.

import * as Debug from 'debug';
const debug = Debug('myNamespace');

Enabling/disabling debug output

This code shows how to enable and disable debug output. By calling Debug.enable with a namespace, you enable logging for that namespace. Calling Debug.disable turns off all debug logging.

Debug.enable('myNamespace');
Debug.disable();

Logging messages

This example demonstrates logging a debug message with a formatted output. The %O token allows you to output an object in a pretty-printed format. Replace '{ some: 'object' }' with any object you wish to log.

debug('Here is a debug message: %O', { some: 'object' });

Other packages similar to @types/debug

winston

Winston is a multi-transport async logging library for Node.js. Unlike @types/debug, which is primarily focused on providing a debugging tool, winston is designed for logging with support for multiple storage options (like files, databases, etc.). It offers more flexibility in terms of logging levels, custom transports, and formatting.

morgan

Morgan is an HTTP request logger middleware for Node.js, making it more specific to logging HTTP requests in web applications. While @types/debug is used for general-purpose debugging in applications, morgan focuses on logging request details, making it more suitable for web servers and APIs.

pino

Pino is a very low overhead Node.js logger, which focuses on performance. It provides structured logging in JSON format. Compared to @types/debug, Pino is more about efficient logging with a focus on application performance and log management, offering features like child loggers and log levels.

README

Installation

npm install --save @types/debug

Summary

This package contains type definitions for debug (https://github.com/debug-js/debug).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/debug.

index.d.ts

declare var debug: debug.Debug & { debug: debug.Debug; default: debug.Debug };

export = debug;
export as namespace debug;

declare namespace debug {
    interface Debug {
        (namespace: string): Debugger;
        coerce: (val: any) => any;
        disable: () => string;
        enable: (namespaces: string) => void;
        enabled: (namespaces: string) => boolean;
        formatArgs: (this: Debugger, args: any[]) => void;
        log: (...args: any[]) => any;
        selectColor: (namespace: string) => string | number;
        humanize: typeof import("ms");

        names: RegExp[];
        skips: RegExp[];

        formatters: Formatters;

        inspectOpts?: {
            hideDate?: boolean | number | null;
            colors?: boolean | number | null;
            depth?: boolean | number | null;
            showHidden?: boolean | number | null;
        };
    }

    type IDebug = Debug;

    interface Formatters {
        [formatter: string]: (v: any) => string;
    }

    type IDebugger = Debugger;

    interface Debugger {
        (formatter: any, ...args: any[]): void;

        color: string;
        diff: number;
        enabled: boolean;
        log: (...args: any[]) => any;
        namespace: string;
        destroy: () => boolean;
        extend: (namespace: string, delimiter?: string) => Debugger;
    }
}

Additional Details

• Last updated: Thu, 09 Nov 2023 03:06:57 GMT
• Dependencies: @types/ms

Credits

These definitions were written by Seon-Wook Park, Gal Talmor, John McLaughlin, Brasten Sager, Nicolas Penin, Kristian Brünn, and Caleb Gregory.