baryon/tracer

Example of how to use tracer with TypeScript

Open

#139 opened on May 20, 2023

View on GitHub
 (3 comments) (1 reaction) (0 assignees)JavaScript (1,137 stars) (124 forks)batch import
help wanted

Description

I see type definitions in the package, but when I try to import and use this way:

import { colorConsole } from 'tracer'

const logger = colorConsole({})
console.error('some error')

It says Property 'error' does not exist on type 'Logger<"error">.

Can you provide some simple example of how to properly import and use tracer with TypeScript?

Thanks!

Contributor guide

Tech stack
typescriptnodejs
Domain
developer experiencedocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript basicsfamiliarity with tracer logging
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requests a TypeScript usage example for the tracer library. Currently, the type definitions cause a type error when importing and using colorConsole. To resolve, examine the type definitions in the tracer package (likely in index.d.ts) to understand the expected usage pattern. Then, provide a simple working example that demonstrates proper import and usage with TypeScript, such as importing specific exports or using generics. Consider adding the example to the README or a dedicated TypeScript usage section.