Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2025-02-18 06:31:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add example of useRuntimeConfig() within a plugin (#2900)

Browse Source
This commit is contained in:
notRyan 2022-01-25 13:04:22 +01:00 committed by GitHub
parent 29fa0c991b
commit a569d16900
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/content/3.docs/1.usage/5.runtime-config.md
View File

@ -77,6 +77,21 @@ const config = useRuntimeConfig()
**`useRuntimeConfig` only works during `setup` or `Lifecycle Hooks`**. **`useRuntimeConfig` only works during `setup` or `Lifecycle Hooks`**.
:: ::
### Plugins
If you want to use the runtime confg within any (custom) plugin, you can use `useRuntimeConfig()` inside of your `defineNuxtPlugin` function.
For example:
```ts
export default defineNuxtPlugin((nuxtApp) => {
const config = useRuntimeConfig();
const url = process.server ? config.serverUrl : config.clientUrl;
// Do something with url & isServer.
});
```
### API routes ### API routes
Within the API routes, you can access runtime config by directly importing from virtual `#config`. Within the API routes, you can access runtime config by directly importing from virtual `#config`.