diff --git a/docs/3.api/4.advanced/2.kit.md b/docs/3.api/4.advanced/2.kit.md index 61f06aad11..d592f9215d 100644 --- a/docs/3.api/4.advanced/2.kit.md +++ b/docs/3.api/4.advanced/2.kit.md @@ -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