Home > @uniformdev/uniform-nuxt > UniformModuleOptions

UniformModuleOptions interface

Signature:

Properties

<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

apiHost?

</td><td>

</td><td>

string

</td><td>

(Optional) The host to be used when calling the API. 'https://uniform.app'

</td></tr> <tr><td>

defaultConsent?

</td><td>

</td><td>

boolean

</td><td>

(Optional) Sets the default value of the user consent. false

</td></tr> <tr><td>

edgeApiHost?

</td><td>

</td><td>

string

</td><td>

(Optional) The host to be used when calling the Edge API. 'https://uniform.global'

</td></tr> <tr><td>

enableContextDevTools?

</td><td>

</td><td>

boolean

</td><td>

(Optional) Enables the [Context DevTools](https://docs.uniform.app/context/getting-started/browser-extension) plugin. true

</td></tr> <tr><td>

manifest?

</td><td>

</td><td>

ManifestV2

</td><td>

(Optional) The Uniform Context manifest. This one is usually fetched right before the app is started using Uniform's CLI. Uniform Context won't be enabled if a manifest is missing.

</td></tr> <tr><td>

outputType?

</td><td>

</td><td>

string

</td><td>

(Optional) Set it to 'edge' when building the app for the edge using [NESI technology](https://docs.uniform.app/context/reference/netlify) 'standard'

</td></tr> <tr><td>

playgroundPath?

</td><td>

</td><td>

string

</td><td>

(Optional) The path to the playground page, to live preview components and patterns.

</td></tr> <tr><td>

projectId

</td><td>

</td><td>

string

</td><td>

The ID of the Uniform project you want to use in your app.

</td></tr> <tr><td>

readOnlyApiKey

</td><td>

</td><td>

string

</td><td>

An API key that has read permissions to your Uniform project. ⚠️ Make sure the API key has only read access, because it's used in Nuxt's public runtime config

</td></tr> <tr><td>

uniformContextPath?

</td><td>

</td><td>

string

</td><td>

(Optional) The path to a file that exports a Unifrom Context instance as default.<br>This will override the values of manifest. Useful for advanced use cases (such us using plugins other than the Context DevTools one).

</td></tr> </tbody></table>