Want to take a look at our new docs? Our new docs are now in beta. Have fun!

The server Property

  • Type: Object

Nuxt.js let you define the server connection variables for your application inside nuxt.config.js.

Basic example (nuxt.config.js):

export default {
  server: {
    port: 8000, // default: 3000
    host: '0.0.0.0', // default: localhost,
    timing: false
  }
}

This lets you specify the host and port for your Nuxt.js server instance.

Example using HTTPS configuration

nuxt.config.js

import path from 'path'
import fs from 'fs'

export default {
  server: {
    https: {
      key: fs.readFileSync(path.resolve(__dirname, 'server.key')),
      cert: fs.readFileSync(path.resolve(__dirname, 'server.crt'))
    }
  }
}

You can find additional information on creating server keys and certificates on localhost on certificates for localhost article.

Example using sockets configuration

export default {
  server: {
    socket: '/tmp/nuxt.socket'
  }
}

timing

  • Type: Object or Boolean
  • Default: false

Enabling the server.timing option adds a middleware to measure the time elapsed during server-side rendering and adds it to the headers as 'Server-Timing'

Example using timing configuration

server.timing can be an object for providing options. Currently, only total is supported (which directly tracks the whole time spent on server-side rendering)

export default {
  server: {
    timing: {
      total: true
    }
  }
}

Using timing api

The timing api is also injected into the response on server-side when server.time is enabled.

Syntax

res.timing.start(name, description)
res.timing.end(name)

Example using timing in servermiddleware

export default function (req, res, next) {
  res.timing.start('midd', 'Middleware timing description')
  // server side operation..
  // ...
  res.timing.end('midd')
  next()
}

Then server-timing head will be included in response header like:

Server-Timing: midd;desc="Middleware timing description";dur=2.4

Please refer to Server-Timing MDN for more details.

Contributors

Contribution for this page is now closed. If you would like to contribute please check out our new docs are now in beta. Have fun!

Platinum Sponsors

StoryblokMoovweb Support Us