mirror of
https://github.com/nuxt/nuxt.git
synced 2025-02-16 13:48:13 +00:00
feat(docs): define useLogger
This commit is contained in:
parent
1bc2e22552
commit
da0fbb5d49
@ -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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user