Skip to content
On this page

How to Track Errors

Although the idea of this module is to mask your real API by creating a Nuxt server proxy, nuxt-api-party will forward error responses to the client if your API fails to deliver, including:

  • statusCode
  • statusMessage
  • API response body as data

Examples

INFO

The examples below assume that you have set up an API endpoint called jsonPlaceholder:

ts
// `nuxt.config.ts`
export default defineNuxtConfig({
  modules: ['nuxt-api-party'],

  apiParty: {
    endpoints: {
      jsonPlaceholder: {
        url: 'https://jsonplaceholder.typicode.com'
      }
    }
  }
})

Usage with useJsonPlaceholderData

ts
const { data, error } = await useJsonPlaceholderData('not-found')

watchEffect(() => {
  if (!error.value)
    return
  console.error('statusCode:', error.value.statusCode)
  console.error('statusMessage:', error.value.statusMessage)
  // Log the API response body
  console.log('data:', error.value.data)
})

Usage with $jsonPlaceholder

ts
function onSubmit() {
  try {
    const response = await $jsonPlaceholder('not-found', {
      method: 'POST',
      body: form.value
    })
  }
  catch (e) {
    console.error('statusCode:', e.statusCode)
    console.error('statusMessage:', e.statusMessage)
    // Log the API response body
    console.error('data:', e.data)
  }
}

Released under the MIT License.