baryon/tracer

Example of how to use tracer with TypeScript

Open

#139 aberto em 20 de mai. de 2023

Ver no 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!

Guia do colaborador

Pilha de tecnologia
typescriptnodejs
Domain
developer experiencedocumentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
TypeScript basicsfamiliarity with tracer logging
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90
Direção de pesquisa
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.