Nuxt/docs/2.guide/2.directory-structure/1.utils.md

1.5 KiB

title head.title description navigation.icon
utils utils/ Use the utils/ directory to auto-import your utility functions throughout your application. i-ph-folder

The main purpose of the utils/ directory is to allow a semantic distinction between your Vue composables and other auto-imported utility functions.

Usage

Method 1: Using named export

export const { format: formatNumber } = Intl.NumberFormat('en-GB', {
  notation: 'compact',
  maximumFractionDigits: 1
})

Method 2: Using default export

// It will be available as randomEntry() (camelCase of file name without extension)
export default function (arr: Array<any>) {
  return arr[Math.floor(Math.random() * arr.length)]
}

You can now use auto imported utility functions in .js, .ts and .vue files

<template>
  <p>{{ formatNumber(1234) }}</p>
</template>

:read-more{to="/docs/guide/concepts/auto-imports"}

:link-example{to="/docs/examples/features/auto-imports"}

::tip The way utils/ auto-imports work and are scanned is identical to the composables/ directory. ::

::important These utils are only available within the Vue part of your app. :br Only server/utils are auto-imported in the server/ directory. ::