Lightweight TypeScript logger with flexible custom transports.
npm install @toreda/log  !Sonar Quality Gate
!GitHub package.json version (branch) !GitHub Release Date 
@toreda/log - Dynamic LoggerLight TypeScript logger for node, web, and serverless environments.
Features:
* Small footprint
* Simple to use
* Fully supports TypeScript
* Custom Transport support
* Works in Browser, Serverless, and Node environments.
* Package
- Install
- Run Tests
- Build
- License
@toreda/log provides simple and straight forward logging for common use cases, and advanced functionality for use in more complicated situations like server-side and remote debugging.
Create Logger
``typescript`
import {Log} from '@toreda/log';
const log = new Log();
Log Levels
`typescript`
import {Log, Levels} from '@toreda/log';
const log = new Log({globalLevel: Levels.DEBUG});
// Change log level:
log.setGlobalLevel(Levels.ALL);
// Disable a specific log level only
log.disableGlobalLevel(Levels.TRACE)
// Disable specific log levels only
log.disableGlobalLevels([Levels.DEBUG, Levels.INFO])
// Enable a specific log level only
log.enableGlobalLevel(Levels.DEBUG)
// Enable specific log levels only
log.enableGlobalLevels([Levels.TRACE, Levels.INFO])
// Trace
log.trace('Trace message here');
// Debug
log.debug('Debug message here');
// Info
log.info('Info message here');
// Warn
log.warn('Warn message here');
// Error
log.error('my', 'message', 'here');
// Multple
log.log(Levels.ERROR & Levels.TRACE, 'trace and error message here');
// Custom
const customLevel =
log.log(0b0010_0000_0000, 'custom logging level');
Groups
New logs can be created from existing logs. The new logs share a state with
the log that created them and have an id that tracks the origin of of the log.
`typescript
import {Log} from '@toreda/log';
const log = new Log({id: 'ClassLog'});
const subLog = log.makeLog('FunctionLog');
// Message has id 'ClassLog'
log.info('Class constructor started.');
// Message has id 'ClassLog.FunctionLog'
subLog.info('Function call started.');
log.globalState === subLog.globalState; // returns true
`
Transports
Transports attach to logs and handle the messages.
A default transport that logs to console can be actived when creating the log.
`typescript
import {Log} from '@toreda/log';
const log = new Log({consoleEnabled: true});
const sublog = log.makeLog('sublog');
// Logs to the console
log.info('Info Message');
// Logs to the console
sublog.info('Info Message');
`
It can also be activated later
`typescript
import {Log} from '@toreda/log';
const log = new Log();
log.activateDefaultConsole();
const sublog = log.makeLog('sublog');
// Logs to the console
log.info('Info Message');
// Does not log to the console
sublog.info('Info Message');
`
Custom transports can also be created
`typescript
import {Log, LogMessage, Transport} from '@toreda/log';
const log = new Log();
// Example dummy example.
// Custom actions can perform any async activity.
const action = async (msg: LogMessage): Promise
return true;
}
// Transports take a string ID, initial log level,
// and async action function.
const transport = new Transport('tid1', LogLevels.ALL, action);
// Add transport to global listeners.
log.addTransport(transport);
`
Removing Transports
`typescript
// Remove the same transport
// NOTE: Requires access to original transport object
// now being removed.
log.removeTransport(transport);
// Remove global transport by ID.
// Use ID to remove global transports if you no
// longer have a reference to target transport.
log.removeTransportById('tid1');
`
directly from NPM.Install with Yarn (preferred)
`bash
yarn add @toreda/log --dev
`Install using NPM
bash
npm install @toreda/log --save-dev
`
Run Tests
Install or clone (see above).Toreda Unit Tests use Jest.
Installing jest is not required after project dependencies are installed (see above).
`bash
yarn test
`
Build from source
The next steps are the same whether you installed the package using NPM or cloned the repo from Github.
$3
Enter the following commands in order from the log project root.
bash
yarn build
`$3
Enter the following commands in order from the log project root.
bash
npm run-script build
``
https://www.toreda.com