# @donews/nestjs-logger

> nestjs logger module

Latest version **0.11.1** (published 2025-03-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @donews/nestjs-logger
pnpm add @donews/nestjs-logger
yarn add @donews/nestjs-logger
bun add @donews/nestjs-logger
```

## Health

**Score 40/100 (D)** — status: stable.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.11.1 |
| Published | 2025-03-07 |
| First published | 2020-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 28.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | toonewLi <litaixin01@163.com> |
| Maintainers | litaixin01, stringang |

## Links

- npm: https://www.npmjs.com/package/@donews/nestjs-logger
- Repository: https://github.com/DoNewsCode/nestjs
- Issues: https://github.com/DoNewsCode/nestjs/issues
- npm.io page: https://npm.io/package/@donews/nestjs-logger

## Recent versions

- 0.11.1 (latest) — 2025-03-07
- 0.11.1-alpha.0 (beta) — 2025-03-06
- 0.10.2 — 2022-03-22
- 0.10.0 — 2022-03-02
- 0.9.3 — 2021-09-22
- 0.9.2 — 2021-07-13
- 0.9.1 — 2021-07-13
- 0.9.0 — 2021-07-12
- 0.8.4 — 2021-06-22
- 0.8.3 — 2021-06-07
- 0.8.1 — 2021-04-14
- 0.8.0 — 2021-04-13
- 0.7.7 — 2021-04-06
- 0.7.6 — 2021-01-28
- 0.7.5 — 2021-01-15
- … 14 more at https://npm.io/package/@donews/nestjs-logger/versions

## README

# nest logger module

## 描述

基于 自我实现伪 json 输出 和 nest`内置logger`的[Nest](https://github.com/nestjs/nest)日志 module。

1. json （伪）
2. plain 格式输出基于 nest 内置 logger

## Install

```shell script
$ npm i @donews/nestjs-logger
```

## Quick Start

假定一个目录结构

```
/root
    /src
        app.module.ts
```

### 1. 模块导入

```typescript
import { LOGGER_TYPE, LoggerModule } from '@donews/nestjs-logger';
import { Module } from '@nestjs/common';

@Module({
  imports: [
    LoggerModule.forRoot({
      loggerType: LOGGER_TYPE.JSON_MODEL,
      loggerLevel: 'debug',
      context: 'text',
    }),
  ],
})
export class AppModule {}
```

### 2. 增加 asynchronous provider

```typescript
LoggerModule.forRootAsync({
  imports: [ConfigModule],
  useFactory: (configService: ConfigService) => ({
    loggerType: configService.get('loggerType'),
    loggerLevel: 'debug',
    context: 'text',
  }),
  inject: [ConfigService],
});
```

### 3. 使用

```typescript
import { LoggerInterface, LOGGER } from '@donews/nestjs-logger';
import { Inject, Injectable } from '@nestjs/common';

@Injectable()
class TestService {
  constructor(
    @Inject(LOGGER)
    private readonly loggerService: LoggerInterface,
  ) {}

  say() {
    this.loggerService.info('message', 'context');
    this.loggerService.error('error', 'trace', 'context');
  }
}
```

### 4. 日志级别顺序

| 级别    | 级别数 |
| ------- | ------ |
| error   | 0      |
| warn    | 1      |
| log     | 2      |
| info    | 2      |
| debug   | 3      |
| verbose | 4      |

级别从高到低

## License

Nest is [MIT licensed](LICENSE).

---
_Source: https://npm.io/package/@donews/nestjs-logger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
