feat(docs): define `useLogger`

This commit is contained in:
Andrey Yolkin 2023-09-03 20:03:07 +03:00
parent 1bc2e22552
commit da0fbb5d49
No known key found for this signature in database
GPG Key ID: 4A2899263001EA49
1 changed files with 33 additions and 1 deletions

View File

@ -2053,7 +2053,39 @@ export default defineNuxtModule({
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/logger.ts)
### `useLogger(scope?)`
### `useLogger`
Returns a logger instance. It uses [consola](https://github.com/unjs/consola) under the hood.
#### Type
```ts
function useLogger (tag?: string): ConsolaInstance
```
#### Parameters
##### `tag`
**Type**: `string`
***Optional**: `true`
A tag to prefix all log messages with.
#### Examples
```ts
import { defineNuxtModule, useLogger } from '@nuxt/kit'
export default defineNuxtModule({
setup(options, nuxt) {
const logger = useLogger('my-module')
logger.info('Hello from my module!')
}
})
```
## Builder