docs: async example

hywax · Mar 22, 2024 · 403e8f7 · 403e8f7
1 parent 215100f
commit 403e8f7
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -71,6 +71,7 @@ export default defineConfig({
           { text: 'Base', link: '/base' },
           { text: 'Run on init', link: '/with-params' },
           { text: 'Custom time', link: '/custom-time' },
+          { text: 'Async', link: '/async' },
         ],
       },
       {

diff --git a/docs/examples/async.md b/docs/examples/async.md
@@ -0,0 +1,16 @@
+# Async
+
+`defineCronHandler` supports async functions.
+
+```ts
+// server/cron/job.ts
+import { defineCronHandler } from '#nuxt/cron'
+
+export default defineCronHandler('houdrly', async () => {
+  const data = $fetch('https://jsonplaceholder.typicode.com/todos/1')
+
+  console.log(data)
+})
+```
+
+A list of all prepared times can be found in [Presets](../api/presets)