Logo for jsDocs.io

@types/npmlog

  • Version 7.0.0
  • Published
  • 5.54 kB
  • 1 dependency
  • MIT license

Install

npm i @types/npmlog
yarn add @types/npmlog
pnpm add @types/npmlog

Overview

TypeScript definitions for npmlog

Index

Variables

Interfaces

Type Aliases

Variables

variable npmlog

var npmlog: npmlog.Logger;

    Interfaces

    interface Logger

    interface Logger extends EventEmitter {}

      property heading

      heading: string;

        property headingStyle

        headingStyle: StyleObject;

          property level

          level: string;

            property maxRecordSize

            maxRecordSize: number;

              property prefixStyle

              prefixStyle: StyleObject;

                property record

                record: MessageObject[];

                  property stream

                  stream: any;

                    method addLevel

                    addLevel: (level: string, n: number, style?: StyleObject, disp?: string) => void;

                      method disableColor

                      disableColor: () => void;

                        method disableProgress

                        disableProgress: () => void;

                          method disableUnicode

                          disableUnicode: () => void;

                            method enableColor

                            enableColor: () => void;

                              method enableProgress

                              enableProgress: () => void;

                                method enableUnicode

                                enableUnicode: () => void;

                                  method error

                                  error: (prefix: string, message: any, ...args: any[]) => void;

                                    method http

                                    http: (prefix: string, message: any, ...args: any[]) => void;

                                      method info

                                      info: (prefix: string, message: any, ...args: any[]) => void;

                                        method log

                                        log: (
                                            level: LogLevels | string,
                                            prefix: string,
                                            message: any,
                                            ...args: any[]
                                        ) => void;

                                        • Creates a log message

                                          Parameter level

                                          Parameter prefix

                                          Parameter message

                                          message of the log which will be formatted using utils.format()

                                          Parameter args

                                          additional arguments appended to the log message also formatted using utils.format()

                                        method notice

                                        notice: (prefix: string, message: any, ...args: any[]) => void;

                                          method pause

                                          pause: () => void;

                                            method progressEnabled

                                            progressEnabled: () => boolean;

                                              method resume

                                              resume: () => void;

                                                method silent

                                                silent: (prefix: string, message: any, ...args: any[]) => void;

                                                  method silly

                                                  silly: (prefix: string, message: any, ...args: any[]) => void;

                                                  • Parameter prefix

                                                    Parameter message

                                                    message of the log which will be formatted using utils.format()

                                                    Parameter args

                                                    additional arguments appended to the log message also formatted using utils.format()

                                                  method timing

                                                  timing: (prefix: string, message: any, ...args: any[]) => void;

                                                    method verbose

                                                    verbose: (prefix: string, message: any, ...args: any[]) => void;

                                                      method warn

                                                      warn: (prefix: string, message: any, ...args: any[]) => void;

                                                        call signature

                                                        (): any;

                                                          index signature

                                                          [key: string]: any;

                                                            interface MessageObject

                                                            interface MessageObject {}

                                                              property id

                                                              id: number;

                                                                property level

                                                                level: string;

                                                                  property message

                                                                  message: string;

                                                                    property messageRaw

                                                                    messageRaw: string;

                                                                      property prefix

                                                                      prefix: string;

                                                                        interface StyleObject

                                                                        interface StyleObject {}

                                                                          property bell

                                                                          bell?: boolean | undefined;

                                                                            property bg

                                                                            bg?: string | undefined;

                                                                              property bold

                                                                              bold?: boolean | undefined;

                                                                                property fg

                                                                                fg?: string | undefined;

                                                                                  property inverse

                                                                                  inverse?: boolean | undefined;

                                                                                    property underline

                                                                                    underline?: boolean | undefined;

                                                                                      Type Aliases

                                                                                      type LogLevels

                                                                                      type LogLevels =
                                                                                          | 'silly'
                                                                                          | 'verbose'
                                                                                          | 'info'
                                                                                          | 'timing'
                                                                                          | 'http'
                                                                                          | 'notice'
                                                                                          | 'warn'
                                                                                          | 'error'
                                                                                          | 'silent';

                                                                                        Package Files (1)

                                                                                        Dependencies (1)

                                                                                        Dev Dependencies (0)

                                                                                        No dev dependencies.

                                                                                        Peer Dependencies (0)

                                                                                        No peer dependencies.

                                                                                        Badge

                                                                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/npmlog.

                                                                                        • Markdown
                                                                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/npmlog)
                                                                                        • HTML
                                                                                          <a href="https://www.jsdocs.io/package/@types/npmlog"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>