@intelika/logger NPM

@intelika/logger

Streamline your app's logging with @Intelika/logger, the ultimate tool for sending logs to Discord, Telegram, and beyond with just one line of code.

Installation

Use the package manager of your choice to install the package:

npm:

npm install @intelika/logger

yarn:

yarn add @intelika/logger

Emitters

Usage

the package can be used in any JavaScript or TypeScript project. Here are some examples of how to use it in different environments.

!NOTE The package is designed to be used with TypeScript, but it can also be used in JavaScript projects.

Nest.js

import { Module } from '@nestjs/common';
import { LogModule } from '@intelika/logger';

@Module({
    imports: [
       LogModule.forRoot({
            isGlobal: true,
            discordWebhook:  'https://discord.com/api/webhooks/...' // optional
        }),
    ],
  providers: [],
  exports: [],
})
export class AppModule {}

// cats.service.ts

import { Injectable } from '@nestjs/common';
import { LogService } from '@intelika/logger';

@Injectable()
export class CatsService {
  constructor(private readonly logger: LogService) {}

    findAll(): string {
        this.logger.log(message).context(CatsService.name).into(Emitter.CONSOLE)
        return 'This action returns all cats';
    }

    findOne(id: number): string {
        this.logger.log(message).context("findOne").into(Emitter.DISCORD)
        return `This action returns a #${id} cat`;
    }
}

everywhere else

import { LogService, Emitter } from '@intelika/logger';

const logger = new LogService('myContext');

// --- OR --- 

// const logger = new LogService({
//   context: 'myContext',
//   discordWebhook: 'https://discord.com/api/webhooks/...'
// })

// const logger = new LogService({
//   telegram: {
//     chatId: '1234567890',
//     token: '1234567890:ABC-DEF1234ghIkl-zyx57W2v1u123ew11'
//   },
//   context: 'myContext'
// })

// const logger = new LogService(bootstrap.name)

// Log a message to the console
logger.log('Hello, world!').into(Emitter.CONSOLE);

// Log a warning to Discord
logger.warn('Something might be wrong...').into(Emitter.DISCORD);

// Log an error to Telegram
logger.error('Something went wrong!').into(Emitter.TELEGRAM);

!TIP
 const logger = new LogService({
  telegram: {
    chatId: '1234567890',
    token: '1234567890:ABC-DEF1234ghIkl-zyx57W2v1u123ew11'
  },
  context: 'myContext'
})
you can use the telegram emitter by providing the chatId and the token of your bot.
!TIP
 const logger = new LogService({
  discordWebhook: 'https://discord.com/api/webhooks/...',
  context: 'myContext'
})
you can use the discord emitter by providing the webhook url.
!TIP
const logService = new LogService('TestContext', {
 file: {
   path: './logs',
   includeDateInFilename: true,
   fileFormat: 'log',
   messageFormat: 'DATE - LEVEL | CONTEXT | MESSAGE'
 }
})
you can use the file emitter by providing the path of the file, the file format, and the message format.