synap-logger

Install

To use this logger in a new TypeScript project, simply:

npm i synap-logger

Usage

The usages listed here are in Typescript.

Simple

import { Logger } from 'synap-logger'

Logger.enableDebug = true;

let logger = new Logger('LOGGER NAME');

logger.success('My first gorgeous message!');
logger.debug('My first debug message!');

Logger.enableDebug = false;

logger.debug("This won't print...");

This prints the message ...

[2017-03-02 18:19:41] [LOGGER NAME SUCCESS] My first gorgeous message!
[2017-03-02 18:19:41] [LOGGER NAME DEBUG] My first debug message!

... with color.

Properties

• counter:number - A counter variable for the count method
• static enableDebug:boolean - When false, debug statements (including count/trace) will not be printed

Setters

• name(name:string) - Prepend the label with a new name

Methods

• success(... args:any[]):void - Mark a log message as success
• warn(... args:any[]):void - Mark a log message as a warning
• info(... args:any[]):void - Mark a log message as information
• debug(... args:any[]):void - Mark a log message as a debug statement
• error(... args:any[]):void - Mark a log message as an error
• trace(... args:any[]):void - Print a trace using console.trace; Similar to debug but the stack trace is printed
• count(... args:any[]):void - Mark a log message as a count; Similar to debug but the count value will be incremented every time this is called

Advanced

• custom(title:string, consoleFunc:string, color:string, ... args:any[]):void - Create a custom log message using the title and color of your choice (label prepended with instance name); used by all instance methods
• static custom(title:string, consoleFunc:string, color:string, ... args:any[]):void - Create a custom log message using the title and color of your choice

Contribute (Internal)

If you make a change to this class, you should follow these steps:

1. Build the project with npm run build

2. Create a test project with npm init in an empty folder and confirm that you can npm i ../path/to/SynapLogger before you try to publish

3. Also confirm that you can create an compile a simple file in the project where you import { Logger } from 'synap-logger'

4. If you need to change the version, use npm version <update_type>

5. If all checks out, publish with npm publish

More information at https://docs.npmjs.com/getting-started/publishing-npm-packages.