# @nestcloud2/logger

> NestCloud is a Node.js micro-service solution, writing by Typescript language and Nest.js.

Latest version **0.8.5** (published 2022-09-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nestcloud2/logger
pnpm add @nestcloud2/logger
yarn add @nestcloud2/logger
bun add @nestcloud2/logger
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.5 |
| Published | 2022-09-12 |
| First published | 2022-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 18 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 419 |
| Author | Miaowing |
| Maintainers | ahdng |

## Links

- npm: https://www.npmjs.com/package/@nestcloud2/logger
- Repository: https://github.com/nest-cloud/nestcloud
- Homepage: https://github.com/nest-cloud/nestcloud#readme
- Issues: https://github.com/nest-cloud/nestcloud/issues
- npm.io page: https://npm.io/package/@nestcloud2/logger

## Dependencies (5)

- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [moment](https://npm.io/package/moment.md) ^2.24.0
- [winston](https://npm.io/package/winston.md) ^2.4.2
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.12
- [winston-daily-rotate-file](https://npm.io/package/winston-daily-rotate-file.md) ^3.8.0

## Recent versions

- 0.8.5 (latest) — 2022-09-12
- 0.9.1 (next) — 2022-10-04
- 0.9.1-rc.0 (test) — 2022-09-14
- 0.9.0 (rc) — 2022-09-14
- 0.8.3 — 2022-05-31
- 0.8.0 — 2022-05-16
- 0.7.21 — 2022-05-16
- 0.7.20 — 2022-05-16

## README

[travis-image]: https://api.travis-ci.org/nest-cloud/nestcloud.svg?branch=master
[travis-url]: https://travis-ci.org/nest-cloud/nestcloud
[linux-image]: https://img.shields.io/travis/nest-cloud/nestcloud/master.svg?label=linux
[linux-url]: https://travis-ci.org/nest-cloud/nestcloud

# NestCloud - Logger

<p align="center">
    <a href="https://www.npmjs.com/~nestcloud" target="_blank"><img src="https://img.shields.io/npm/v/@nestcloud2/core.svg" alt="NPM Version"/></a>
    <a href="https://www.npmjs.com/~nestcloud" target="_blank"><img src="https://img.shields.io/npm/l/@nestcloud2/core.svg" alt="Package License"/></a>
    <a href="https://www.npmjs.com/~nestcloud" target="_blank"><img src="https://img.shields.io/npm/dm/@nestcloud2/core.svg" alt="NPM Downloads"/></a>
    <a href="https://travis-ci.org/nest-cloud/nestcloud" target="_blank"><img src="https://travis-ci.org/nest-cloud/nestcloud.svg?branch=master" alt="Travis"/></a>
    <a href="https://travis-ci.org/nest-cloud/nestcloud" target="_blank"><img src="https://img.shields.io/travis/nest-cloud/nestcloud/master.svg?label=linux" alt="Linux"/></a>
    <a href="https://coveralls.io/github/nest-cloud/nestcloud?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nest-cloud/nestcloud/badge.svg?branch=master" alt="Coverage"/></a>
</p>

## Description

The logger module for nestcloud.

## Installation

```bash
$ npm i --save @nestcloud2/logger
```

## Quick Start

```typescript
import { NestFactory } from '@nestjs/core';
import { resolve } from 'path';
import { NestLogger } from '@nestcloud2/logger';
import { AppModule } from './app.module';

async function bootstrap() {
    const app = await NestFactory.create(AppModule, {
        logger: new NestLogger({
            filePath: resolve(__dirname, 'config.yaml'),
        }),
    });
}
```

### Configurations

```yaml
logger:
    level: info
    transports:
        - transport: console
          level: debug
          colorize: true
          datePattern: YYYY-MM-DD h:mm:ss
          label: user-service
        - transport: file
          name: info
          filename: info.log
          datePattern: YYYY-MM-DD h:mm:ss
          label: user-service
          # 100M
          maxSize: 104857600
          json: false
          maxFiles: 10
        - transport: dailyRotateFile
          filename: info.log
          datePattern: YYYY-MM-DD-HH
          zippedArchive: true
          maxSize: 20m
          maxFiles: 14d
```

### Usage

#### Inject logger instance

```typescript
import { Module } from '@nestjs/common';
import { LoggerModule } from '@nestcloud2/logger';

@Module({
    imports: [LoggerModule.forRoot()],
})
export class AppModule {}
```

```typescript
import { Injectable, Logger } from '@nestjs/common';
import { InjectLogger } from '@nestcloud2/logger';

@Injectable()
export class TestService {
    constructor(@InjectLogger() private readonly logger: Logger) {}

    log() {
        this.logger.log('The first log');
    }
}
```

#### Custom Typeorm Logger

```typescript
import { Module, NEST_TYPEORM_LOGGER_PROVIDER } from '@nestjs/common';
import { TypeormLogger } from '@nestcloud2/logger';
import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
    imports: [
        TypeOrmModule.forRootAsync({
            useFactory: (logger: TypeormLogger) => ({
                /* ... */
                logger,
            }),
            inject: [NEST_TYPEORM_LOGGER_PROVIDER],
        }),
    ],
})
export class AppModule {}
```

## Stay in touch

-   Author - [NestCloud](https://github.com/nest-cloud)

## License

NestCloud is [MIT licensed](LICENSE).

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