nuxt-newt

Newt integration for Nuxt.

Quick Setup

1. Install the module to your Nuxt application with one command

npx nuxi module add nuxt-newt

2. Add spaceUid and cdnApiToken to the newt section of nuxt.config.ts

export default defineNuxtConfig({
  modules: ["nuxt-newt"],
  newt: {
    spaceUid: process.env.NEWT_SPACE_UID,
    cdnApiToken: process.env.NEWT_CDN_API_TOKEN,
  },
})

3. Add your Newt spaceUid and cdnApiToken to the .env file

NEWT_SPACE_UID='YOUR_SPACE_UID'
NEWT_CDN_API_TOKEN='YOUR_CDN_API_TOKEN'

Usage

useNewtGetContents: Get contents

<script setup lang="ts">
const { data } = await useNewtGetContents<T>(key, {
  appUid: 'YOUR_APP_UID',
  modelUid: 'YOUR_MODEL_UID',
  query: {
    // Add your query here (optional)
  },
});
</script>

useNewtGetContent: Get a content

<script lang='ts' setup>
const { data } = await useNewtGetContent<T>(key, {
  appUid: 'YOUR_APP_UID',
  modelUid: 'YOUR_MODEL_UID',
  contentId: 'YOUR_CONTENT_ID',
  query: {
    // Add your query here (optional)
  },
});
</script>

useNewtGetFirstContent: Get first content

<script lang='ts' setup>
const { data } = await useNewtGetFirstContent<T>(key, {
  appUid: 'YOUR_APP_UID',
  modelUid: 'YOUR_MODEL_UID',
  query: {
    // Add your query here (optional)
  },
});
</script>

query details

• CDN API Reference | Newt

Contribution

Local development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release