Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@alwatr/logger

Package Overview
Dependencies
Maintainers
1
Versions
78
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@alwatr/logger

Fancy colorful console debugger with custom scope written in tiny TypeScript, ES module.

  • 0.24.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
670
increased by8.59%
Maintainers
1
Weekly downloads
 
Created
Source

Alwatr Logger - @alwatr/logger

Fancy colorful console debugger with custom scope written in tiny TypeScript, ES module.

Example usage

import {createLogger} from 'https://esm.run/@alwatr/logger';

const logger = createLogger('demo');

function sayHello(name: string) {
  logger.logMethodArgs('sayHello', {name});
}

Debug Mode

Many of the methods in the logger are no-ops when the debug mode is off in the browser. Please remember to reload the window after changing the debug mode.

  • Debugging all scopes

    window.localStorage?.setItem('ALWATR_DEBUG', '*');
    
  • Debugging specific scope

    window.localStorage?.setItem('ALWATR_DEBUG', 'scope_name');
    
  • Debugging some scopes with pattern

    window.localStorage?.setItem('ALWATR_DEBUG', '*alwatr*');
    

Make sure the log level in set correctly.

API

createLogger(scope: string, color: string, force = boolean)

Create a logger function for fancy console debug with custom scope.

  • color is optional and automatically select from internal fancy color list.
  • debug is optional and automatically detect from localStorage ALWATR_DEBUG item or process.env.ALWATR_DEBUG

Example:

import {createLogger} from 'https://esm.run/@alwatr/logger';
const logger = createLogger('logger/demo');

logger.debug: boolean

Debug state for current scope base on localStorage ALWATR_DEBUG pattern.

logger.color: string

Debug state for current scope base on localStorage ALWATR_DEBUG pattern.

logger.scope: string

Debug state for current scope base on localStorage ALWATR_DEBUG pattern.

logger.logProperty(property, value)

console.debug property change.

Example:

logger.logProperty('name', 'ali');

logger.logMethod(method)

console.debug function or method calls.

Example:

function myMethod() {
  logger.logMethod('myMethod');
}

logger.logMethodArgs(method, args)

console.debug function or method calls with arguments.

Example:

function myMethod(a: number, b: number) {
  logger.logMethodArgs('myMethod', {a, b});
}

logger.logMethodFull(method, args, result)

console.debug function or method calls with arguments.

Example:

function add(a: number, b: number): number {
  const result = a + b;
  logger.logMethodFull('add', {a, b}, result);
  return result;
}

logger.incident(method, code, description, ...args)

console.log an event or expected accident. (not warn or error)

Example:

logger.incident('fetch', 'abort_signal', 'aborted signal received', {url: '/test.json'});

logger.accident(method, code, description, ...args)

console.warn an unexpected accident or error that you handled.

Example:

logger.accident('fetch', 'file_not_found', 'url requested return 404 not found', {
  url: '/test.json',
});

logger.error(method, code, errorStack, ...args)

console.error an unexpected error.

Example:

try {
  ...
}
catch (err) {
  logger.error('myMethod', 'error_code', (err as Error).stack || err, {a: 1, b: 2});
}

logger.logOther(...args)

Simple console.debug with styled scope.

Example:

logger.logOther('foo:', 'bar', {a: 1});

How to handle promises?

For example with a promise function with error:

const failPromiseTest = (): Promise<never> => new Promise((_, reject) => reject(new Error('my_error_code')));

Best practices to catch the error and log it:

// Unhandled promise rejection (just log it)
failPromiseTest().catch((err) =>
  logger.error('myMethod', (err as Error).message || 'error_code', (err as Error).stack || err)
);

// Handled promise rejection
try {
  await failPromiseTest();
} catch (err) {
  logger.accident(
    'myMethod',
    'error_code',
    'failPromiseTest failed!, ' + (err as Error).message,
    (err as Error).stack || err
  );
  // do something to handle the error...
}

Keywords

FAQs

Package last updated on 28 Nov 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc