Need help with nuxt-payload-extractor?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

DreaMinder
141 Stars 17 Forks MIT License 61 Commits 4 Opened issues

Description

Nuxt.js module that makes `nuxt generate` command to store html and payload separately.

Services available

!
?

Need anything else?

Contributors list

Nuxt payload extractor

Nuxt.js module that makes

nuxt generate
command to store data payload in
dist
dir implementing full static generation. See it in action on my site: DreaMinder.pro

⚠️⚠️⚠️ This feature called "full static generated mode" has been released as a native Nuxt.js feature recently. You might want to try it out before using this module, it is much more powerful. ⚠️⚠️⚠️

Benefits

✓ If you use external API to fill your project with data, even after your site has been prerendered, you need to keep your API running to make client-side navigation possible. With this module your API data stores along with prerendered HTML, so the issue is solved

✓ Increases page download speed for crawlers

✓ Makes HTML source code look cleaner

✓ Decreases load on API server

✓ Makes prerendered and client rendered pages consistent in case API data changed after you deployed prerendered pages

✓ Decreases initial page download time x1.5-2 (which is actually doesn't affect perfomance)

Setup

  • Add
    nuxt-payload-extractor
    dependency
  • Define nuxt module:
{
  modules: [
   'nuxt-payload-extractor'
  ]
}
  • Add asyncData custom logic with $payloadURL helper
async asyncData({ $axios, $payloadURL, route }){
  //if generated and works as client navigation, fetch previously saved static JSON payload
  if(process.static && process.client && $payloadURL)
    return await $axios.$get($payloadURL(route))

//your request logic let post = await $axios.$get(/post.json) return { post } }

  • Run
    npm run generate

GraphQL usage

You'll need axios in your production bundle, your graphQL client is only invoked server-side, on 'generate' command.

async asyncData({ $axios, $payloadURL, route, app }) {
  if (process.static && process.client && $payloadURL) {
    return await $axios.$get($payloadURL(route))
  } else {
    let gqlData = await app.apolloProvider.defaultClient.query({
      query: gqlquery
    })
    return {
      gqlData
    }
  }
}

Options

You can blacklist specific paths using

blacklist: []
options. They will be generated in native way. But you have to disable payload request inside of asyncData yourself. Check out example dir for details.

All payloads have timestamp applied to their names for better cache invalidation. You can turn them off by using

versioning: false
option. Keep in mind that timestamp changes on every generate run. Also,
nuxt generate --no-build
is not supported in this case.

Caveats

  • Are you using nested routes (with
    )? This case isn't compatible with 
    nuxt-payload-extractor
    . It will only work if parent and child routes return different data-keys (ex.
    return { postsList }
    and
    return { singlePost }
    ).
  • Are you filling your vuex store with page-specific data? It will break on client-side navigation. Use
    NuxtServerInit
    action for global vuex data or return your vuex data from
    asyncData
    to make it work.

How it works

  • Extracts
     replacing it with 
    
    
  • Makes two files along with
    index.html
    of a prerendered page:
    payload.js
    for initial page load and
    payload.json
    for client-side navigation

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.