p-sw/nestlogged
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: import in docs

Browse Source
This commit is contained in:
Shinwoo PARK 2023-11-17 18:30:39 +09:00
parent 6d95578dcf
commit 185e22cb84
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
dist/README.md vendored
View File

@ -7,7 +7,7 @@ It only uses Logger provided by @nestjs/common package and some dependencies req
### Route Logging ### Route Logging
```ts ```ts
import {Controller, Get} from "@nestjs/common"; import {Controller, Get} from "@nestjs/common";
import {LoggedRoute} from "./logged"; import {LoggedRoute} from "nlogdec";
@Controller('whatever') @Controller('whatever')
export class WhateverController { export class WhateverController {
@ -32,7 +32,7 @@ If function throws any exception, it will also catch exception, log that, and th
```ts ```ts
import {BadRequestException, Controller, Get} from "@nestjs/common"; import {BadRequestException, Controller, Get} from "@nestjs/common";
import {LoggedRoute} from "./logged"; import {LoggedRoute} from "nlogdec";
@Controller('whatever') @Controller('whatever')
export class WhateverController { export class WhateverController {
@ -55,7 +55,7 @@ Not only HTTP exception, it will also catch all exceptions and log it.
### Function Logging ### Function Logging
```ts ```ts
import {LoggedFunction} from "./logged"; import {LoggedFunction} from "nlogdec";
@LoggedFunction // This decorator will do the magic for you @LoggedFunction // This decorator will do the magic for you
export async function doILikeThis(stuff: "apple" | "banana"): "yes" | "no" { export async function doILikeThis(stuff: "apple" | "banana"): "yes" | "no" {
@ -72,8 +72,7 @@ Like `LoggedRoute` decorator, it will automatically catch all exceptions, log it
### Parameter Logging ### Parameter Logging
```ts ```ts
import {LoggedFunction} from "./logged"; import {LoggedParam, LoggedFunction} from "nlogdec";
import {LoggedParam} from "./reflected";
@LoggedFunction @LoggedFunction
export async function doILikeThis( export async function doILikeThis(
@ -101,9 +100,12 @@ You can do scoped logging with `InjectLogger` decorator.
Like tracebacks, it will add a scope and call stacks in log, so you can easily follow logs. Like tracebacks, it will add a scope and call stacks in log, so you can easily follow logs.
```ts ```ts
import {LoggedFunction} from "./logged"; import {
import {InjectLogger, LoggedParam} from "./reflected"; LoggedFunction,
import {ScopedLogger} from "./logger"; LoggedParam,
InjectLogger,
ScopedLogger
} from "nlogdec";
@LoggedFunction @LoggedFunction
export async function doILikeThis( export async function doILikeThis(
@ -121,9 +123,12 @@ Then, in controller:
```ts ```ts
import {BadRequestException, Controller, Get, Param} from "@nestjs/common"; import {BadRequestException, Controller, Get, Param} from "@nestjs/common";
import {LoggedRoute} from "./logged"; import {
import {InjectLogger, LoggedParam} from "./reflected"; LoggedRoute,
import {ScopedLogger} from "./logger"; InjectLogger,
LoggedParam,
ScopedLogger
} from "./logged";
@Controller('you') @Controller('you')
export class WhateverController { export class WhateverController {