Home > @uniformdev/uniform-nuxt > UniformModuleOptions
UniformModuleOptions interface
Signature:
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| apiHost? | string | (Optional) The host to be used when calling the API. 'https://uniform.app' | |
| defaultConsent? | boolean | (Optional) Sets the default value of the user consent. false | |
| edgeApiHost? | string | (Optional) The host to be used when calling the Edge API. 'https://uniform.global' | |
| enableContextDevTools? | boolean | (Optional) Enables the [Context DevTools](https://docs.uniform.app/context/getting-started/browser-extension) plugin. true | |
| manifest? | ManifestV2 | (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. | |
| outputType? | string | (Optional) Set it to 'edge' when building the app for the edge using [NESI technology](https://docs.uniform.app/context/reference/netlify) 'standard' | |
| playgroundPath? | string | (Optional) The path to the playground page, to live preview components and patterns. | |
| projectId | string | The ID of the Uniform project you want to use in your app. | |
| readOnlyApiKey | string | 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 | |
| uniformContextPath? | string | (Optional) The path to a file that exports a Unifrom Context instance as default.<br>This will override the values of <code>manifest</code>, <code>defaultConsent</code> and <code>enableContextDevTools</code>. Useful for advanced use cases (such us using plugins other than the Context DevTools one). |