Skip to main content

Getting Started

Introduction​

A global logging system integrated with Sentry and Slack, designed to provide seamless error tracking and real-time logging across your application.

Installing the Library​

Install @codeleap/logger using Bun:

bun add @codeleap/logger

Setup​

Import logger from the library and initialize it:

src/logger.ts
import { logger } from '@codeleap/logger'
import { Settings } from 'example.ts'

logger.initialize(Settings)

logger.debug = () => null
logger.info = () => null
logger.error = () => null
logger.warn = () => null
logger.log = () => null

logger.slack.setApi(api)

// @ts-expect-error
global.logger = logger

Declaring the Global Logger Module​

To make the logger globally accessible, declare it in your type definitions file:

index.d.ts
import { Logger } from '@codeleap/logger'

declare global {
  const logger: Logger
}

Now your global logger is ready to be used across your application. 🚀