Update docs to reflect import changes

dulnan · Jan 8, 2023 · ec9a846 · ec9a846
1 parent e3209e3
commit ec9a846
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 12 deletions.
diff --git a/docs/advanced/default-values.md b/docs/advanced/default-values.md
@@ -39,7 +39,7 @@ middleware](https://nuxt.com/docs/guide/directory-structure/server#server-middle
 
 ::: code-group
 ```typescript [./server/middleware/routeCache.ts]
-import { useRouteCache } from '#nuxt-multi-cache'
+import { useRouteCache } from '#nuxt-multi-cache/composables'
 
 export default defineEventHandler((event) => {
   // Cache all routes for 7 days.
@@ -156,7 +156,7 @@ useCDNHeaders((helper) => {
 
 ::: code-group
 ```typescript [./server/middleware/routeCache.ts]
-import { useRouteCache } from '#nuxt-multi-cache'
+import { useRouteCache } from '#nuxt-multi-cache/composables'
 
 export default defineEventHandler((event) => {
   useCDNHeaders((helper) => {

diff --git a/docs/advanced/route-and-cdn.md b/docs/advanced/route-and-cdn.md
@@ -13,7 +13,7 @@ does not affect the max age of the CDN cache control header.
 Decide in a middleware where the page should be cached.
 
 ```typescript
-import { useCDNHeaders } from '#nuxt-multi-cache'
+import { useCDNHeaders } from '#nuxt-multi-cache/composables'
 
 export default defineEventHandler((event) => {
   if (event.path.startsWith('/dashboard')) {

diff --git a/docs/features/cdn-cache-control.md b/docs/features/cdn-cache-control.md
@@ -109,7 +109,7 @@ automatically. In addition you have to provide the H3Event object as the second
 argument:
 
 ```typescript
-import { useCDNHeaders } from '#nuxt-multi-cache'
+import { useCDNHeaders } from '#nuxt-multi-cache/composables'
 
 export default defineEventHandler((event) => {
   useCDNHeaders((helper) => {

diff --git a/docs/features/data-cache.md b/docs/features/data-cache.md
@@ -66,7 +66,7 @@ You can use it in custom server handlers, but you have to provide the `H3Event`
 object as the second argument.
 
 ```typescript
-import { useDataCache } from '#nuxt-multi-cache'
+import { useDataCache } from '#nuxt-multi-cache/composables'
 
 export default defineEventHandler(async (event) => {
   const { value, addToCache } = await useDataCache('weather')

diff --git a/docs/features/route-cache.md b/docs/features/route-cache.md
@@ -50,7 +50,7 @@ The composable is not imported automatically and you have to provide the
 `H3Event` object as the second argument:
 
 ```typescript
-import { useRouteCache } from '#nuxt-multi-cache'
+import { useRouteCache } from '#nuxt-multi-cache/composables'
 
 const getResult = function () {
   return new Promise((resolve) => {

diff --git a/playground/server/api/cdnHeaders.ts b/playground/server/api/cdnHeaders.ts
@@ -1,4 +1,4 @@
-import { useCDNHeaders } from '#nuxt-multi-cache'
+import { useCDNHeaders } from '#nuxt-multi-cache/composables'
 
 export default defineEventHandler((event) => {
   useCDNHeaders((helper) => {

diff --git a/playground/server/api/delay.ts b/playground/server/api/delay.ts
@@ -1,4 +1,4 @@
-import { useRouteCache } from '#nuxt-multi-cache'
+import { useRouteCache } from '#nuxt-multi-cache/composables'
 
 const getResult = function () {
   return new Promise((resolve) => {

diff --git a/playground/server/api/test.ts b/playground/server/api/test.ts
@@ -1,4 +1,4 @@
-import { useCDNHeaders, useRouteCache } from '#nuxt-multi-cache'
+import { useCDNHeaders, useRouteCache } from '#nuxt-multi-cache/composables'
 
 export default defineEventHandler((event) => {
   const cacheTags: string[] = [

diff --git a/playground/server/api/withCacheTags.ts b/playground/server/api/withCacheTags.ts
@@ -1,4 +1,4 @@
-import { useRouteCache } from '#nuxt-multi-cache'
+import { useRouteCache } from '#nuxt-multi-cache/composables'
 
 export default defineEventHandler((event) => {
   useRouteCache((helper) => {

diff --git a/src/module.ts b/src/module.ts
@@ -82,7 +82,7 @@ export default defineNuxtModule<ModuleOptions>({
     // Add RenderCacheable component if feature is enabled.
     if (options.component) {
       await addComponent({
-        filePath: resolve('./runtime/components/RenderCacheable/index.ts'),
+        filePath: resolve('./runtime/components/RenderCacheable/index'),
         name: 'RenderCacheable',
         global: true,
       })
@@ -112,7 +112,8 @@ export default defineNuxtModule<ModuleOptions>({
       })
     }
 
-    // Hooks into sending the response.
+    // Hooks into sending the response and adds route to cache and adds CDN
+    // headers.
     if (options.cdn?.enabled || options.route?.enabled) {
       addServerHandler({
         handler: resolve('./runtime/serverHandler/responseSend'),