v3.17
Nuxt on GitHub

Logging

Source
Nuxt Kit provides a set of utilities to help you work with logging. These functions allow you to log messages with extra features.

Nuxt provides a logger instance that you can use to log messages with extra features. useLogger allows you to get a logger instance.

useLogger

Returns a logger instance. It uses consola under the hood.

Usage

import { defineNuxtModule, useLogger } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options, nuxt) {
    const logger = useLogger('my-module')

    logger.info('Hello from my module!')
  },
})

Type

function useLogger (tag?: string, options?: Partial<ConsolaOptions>): ConsolaInstance

Parameters

tag: A tag to suffix all log messages with.

options: Consola configuration options.

Examples

import { defineNuxtModule, useLogger } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options, nuxt) {
    const logger = useLogger('my-module', { level: options.quiet ? 0 : 3 })

    logger.info('Hello from my module!')
  },
})