beautylog

  • Version 6.1.10
  • Published
  • 8 dependencies
  • MIT license

Install

npm i beautylog
yarn add beautylog
pnpm add beautylog

Overview

beautiful logging, TypeScript ready

Index

Variables

variable ora

let ora: Ora;

    Functions

    function dir

    dir: (logText: any) => void;
    • logs an directory to console

      Parameter logText

      Returns

      {boolean}

    function error

    error: (logText: any) => void;
    • logs an error to console

      Parameter logText

      Returns

      {boolean}

    function figlet

    figlet: (textArg: string, optionsArg?: any) => Promise<{}>;

      function figletSync

      figletSync: (textArg: string, optionsArg?: IFigletOptions) => boolean;

        function info

        info: (logText: any) => void;

          function log

          log: (logText: any) => void;
          • logs an info to console

            Parameter logText

            Returns

            {boolean}

          function logReduced

          logReduced: (logTextArg: string, repeatEveryTimesArg?: number) => void;
          • logs a reduced log that only logs changes of consequential log messages

          function newLine

          newLine: (linesArg?: number) => void;
          • creates a new empty line

            Parameter linesArg

            Returns

            void

          function note

          note: (logText: any) => void;
          • note

          function ok

          ok: (logText: any) => void;
          • logs an 'OK!' message to console

            Parameter logText

            Returns

            {boolean}

          function registerRemote

          registerRemote: (remoteArg: any) => void;
          • registers a remote

          function success

          success: (logText: any) => void;
          • logs a success to console

            Parameter logText

            string to log as error

            Returns

            {boolean}

          function warn

          warn: (logText: any) => void;
          • logs a 'warn:' message to console

            Parameter logText

            string to log as error

            Returns

            {boolean}

          Package Files (5)

          Dependencies (8)

          Dev Dependencies (5)

          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/beautylog.

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