feat: cache for one minute

Author: atinux

README.md

@@ -22,10 +22,19 @@ export default defineNuxtConfig({
   modules: [
     '@nuxt/content', // Required
     '@docus/github'
-  ]
+  ],
+  github: {
+    repo: 'nuxt/framework'
+  }
 })
 ```
 
+Lastly, create a [personal access token](https://github.com/settings/tokens) on GitHub and add it into your `.env`:
+
+```env
+GITHUB_TOKEN='<your-personal-token>'
+```
+
 ## Usage
 
 ```vue
@@ -43,6 +52,27 @@ const { data: releases } = await useAsyncData('releases', () => githubReleases()
 </template>
 ```
 
+## Options
+
+```ts
+github: {
+  repo: string,
+  releases: false | {
+    api: string
+    repo: string
+    token: string
+    /**
+     * Parse release notes markdown and return AST tree
+     *
+     * Note: This option is only available when you have `@nuxt/content` installed in your project.
+     *
+     * @default true
+     */
+    parse: boolean
+  }
+}
+```
+
 ## Development
 
 1. Run `npm run dev:prepare` to generate type stubs.

src/runtime/server/api/releases.ts

@@ -1,4 +1,3 @@
-import { defineEventHandler } from 'h3'
 import * as imports from '#imports'
 
 interface GithubRawRelease {
@@ -17,7 +16,7 @@ interface GithubReleasesOptions {
   token: string
 }
 
-export default defineEventHandler(async () => {
+export default imports.defineCachedEventHandler(async () => {
   const { releases: releasesConfig } = imports.useRuntimeConfig().github
 
   // Fetches releases from GitHub
@@ -39,6 +38,8 @@ export default defineEventHandler(async () => {
   releases.sort((a, b) => a.v !== b.v ? b.v - a.v : a.date - b.date)
 
   return releases
+}, {
+  maxAge: 60 // cache for one minute
 })
 
 const normalizeReleaseName = (name: string) => {