1+ <!DOCTYPE html>
2+ < html lang ="en-US " dir ="ltr ">
3+ < head >
4+ < meta charset ="utf-8 ">
5+ < meta name ="viewport " content ="width=device-width,initial-scale=1 ">
6+ < title > Runtime API Examples | Node-Cron</ title >
7+ < meta name ="description " content ="A Lightweight Task Scheduler for Node.js ">
8+ < meta name ="generator " content ="VitePress v1.6.3 ">
9+ < link rel ="preload stylesheet " href ="/assets/style.BH98xyTG.css " as ="style ">
10+ < link rel ="preload stylesheet " href ="/vp-icons.css " as ="style ">
11+
12+ < script type ="module " src ="/assets/app.COZNFknJ.js "> </ script >
13+ < link rel ="preload " href ="/assets/inter-roman-latin.Di8DUHzh.woff2 " as ="font " type ="font/woff2 " crossorigin ="">
14+ < link rel ="modulepreload " href ="/assets/chunks/theme.BwPFtoA5.js ">
15+ < link rel ="modulepreload " href ="/assets/chunks/framework.Dh1jimFm.js ">
16+ < link rel ="modulepreload " href ="/assets/api-examples.md.CRRh3xeI.lean.js ">
17+ < script id ="check-dark-mode "> ( ( ) => { const e = localStorage . getItem ( "vitepress-theme-appearance" ) || "auto" , a = window . matchMedia ( "(prefers-color-scheme: dark)" ) . matches ; ( ! e || e === "auto" ?a :e === "dark" ) && document . documentElement . classList . add ( "dark" ) } ) ( ) ; </ script >
18+ < script id ="check-mac-os "> document . documentElement . classList . toggle ( "mac" , / M a c | i P h o n e | i P o d | i P a d / i. test ( navigator . platform ) ) ; </ script >
19+ </ head >
20+ < body >
21+ < div id ="app "> < div class ="Layout " data-v-d8b57b2d > <!--[--> <!--]--> <!--[--> < span tabindex ="-1 " data-v-fcbfc0e0 > </ span > < a href ="#VPContent " class ="VPSkipLink visually-hidden " data-v-fcbfc0e0 > Skip to content</ a > <!--]--> <!----> < header class ="VPNav " data-v-d8b57b2d data-v-7ad780c2 > < div class ="VPNavBar " data-v-7ad780c2 data-v-9fd4d1dd > < div class ="wrapper " data-v-9fd4d1dd > < div class ="container " data-v-9fd4d1dd > < div class ="title " data-v-9fd4d1dd > < div class ="VPNavBarTitle has-sidebar " data-v-9fd4d1dd data-v-9f43907a > < a class ="title " href ="/ " data-v-9f43907a > <!--[--> <!--]--> <!----> < span data-v-9f43907a > Node-Cron</ span > <!--[--> <!--]--> </ a > </ div > </ div > < div class ="content " data-v-9fd4d1dd > < div class ="content-body " data-v-9fd4d1dd > <!--[--> <!--]--> < div class ="VPNavBarSearch search " data-v-9fd4d1dd > <!----> </ div > < nav aria-labelledby ="main-nav-aria-label " class ="VPNavBarMenu menu " data-v-9fd4d1dd data-v-afb2845e > < span id ="main-nav-aria-label " class ="visually-hidden " data-v-afb2845e > Main Navigation </ span > <!--[--> <!--[--> < a class ="VPLink link VPNavBarMenuLink " href ="/ " tabindex ="0 " data-v-afb2845e data-v-815115f5 > <!--[--> < span data-v-815115f5 > Home</ span > <!--]--> </ a > <!--]--> <!--[--> < a class ="VPLink link VPNavBarMenuLink " href ="/getting-started.html " tabindex ="0 " data-v-afb2845e data-v-815115f5 > <!--[--> < span data-v-815115f5 > Getting Started</ span > <!--]--> </ a > <!--]--> <!--]--> </ nav > <!----> < div class ="VPNavBarAppearance appearance " data-v-9fd4d1dd data-v-3f90c1a5 > < button class ="VPSwitch VPSwitchAppearance " type ="button " role ="switch " title aria-checked ="false " data-v-3f90c1a5 data-v-be9742d9 data-v-b4ccac88 > < span class ="check " data-v-b4ccac88 > < span class ="icon " data-v-b4ccac88 > <!--[--> < span class ="vpi-sun sun " data-v-be9742d9 > </ span > < span class ="vpi-moon moon " data-v-be9742d9 > </ span > <!--]--> </ span > </ span > </ button > </ div > < div class ="VPSocialLinks VPNavBarSocialLinks social-links " data-v-9fd4d1dd data-v-ef6192dc data-v-e71e869c > <!--[--> < a class ="VPSocialLink no-icon " href ="https://www.npmjs.com/package/node-cron " aria-label ="npm " target ="_blank " rel ="noopener " data-v-e71e869c data-v-60a9a2d3 > < span class ="vpi-social-npm "> </ span > </ a > < a class ="VPSocialLink no-icon " href ="https://github.com/noce-cron/node-cron " aria-label ="github " target ="_blank " rel ="noopener " data-v-e71e869c data-v-60a9a2d3 > < span class ="vpi-social-github "> </ span > </ a > <!--]--> </ div > < div class ="VPFlyout VPNavBarExtra extra " data-v-9fd4d1dd data-v-f953d92f data-v-bfe7971f > < button type ="button " class ="button " aria-haspopup ="true " aria-expanded ="false " aria-label ="extra navigation " data-v-bfe7971f > < span class ="vpi-more-horizontal icon " data-v-bfe7971f > </ span > </ button > < div class ="menu " data-v-bfe7971f > < div class ="VPMenu " data-v-bfe7971f data-v-20ed86d6 > <!----> <!--[--> <!--[--> <!----> < div class ="group " data-v-f953d92f > < div class ="item appearance " data-v-f953d92f > < p class ="label " data-v-f953d92f > Appearance</ p > < div class ="appearance-action " data-v-f953d92f > < button class ="VPSwitch VPSwitchAppearance " type ="button " role ="switch " title aria-checked ="false " data-v-f953d92f data-v-be9742d9 data-v-b4ccac88 > < span class ="check " data-v-b4ccac88 > < span class ="icon " data-v-b4ccac88 > <!--[--> < span class ="vpi-sun sun " data-v-be9742d9 > </ span > < span class ="vpi-moon moon " data-v-be9742d9 > </ span > <!--]--> </ span > </ span > </ button > </ div > </ div > </ div > < div class ="group " data-v-f953d92f > < div class ="item social-links " data-v-f953d92f > < div class ="VPSocialLinks social-links-list " data-v-f953d92f data-v-e71e869c > <!--[--> < a class ="VPSocialLink no-icon " href ="https://www.npmjs.com/package/node-cron " aria-label ="npm " target ="_blank " rel ="noopener " data-v-e71e869c data-v-60a9a2d3 > < span class ="vpi-social-npm "> </ span > </ a > < a class ="VPSocialLink no-icon " href ="https://github.com/noce-cron/node-cron " aria-label ="github " target ="_blank " rel ="noopener " data-v-e71e869c data-v-60a9a2d3 > < span class ="vpi-social-github "> </ span > </ a > <!--]--> </ div > </ div > </ div > <!--]--> <!--]--> </ div > </ div > </ div > <!--[--> <!--]--> < button type ="button " class ="VPNavBarHamburger hamburger " aria-label ="mobile navigation " aria-expanded ="false " aria-controls ="VPNavScreen " data-v-9fd4d1dd data-v-6bee1efd > < span class ="container " data-v-6bee1efd > < span class ="top " data-v-6bee1efd > </ span > < span class ="middle " data-v-6bee1efd > </ span > < span class ="bottom " data-v-6bee1efd > </ span > </ span > </ button > </ div > </ div > </ div > </ div > < div class ="divider " data-v-9fd4d1dd > < div class ="divider-line " data-v-9fd4d1dd > </ div > </ div > </ div > <!----> </ header > < div class ="VPLocalNav has-sidebar empty " data-v-d8b57b2d data-v-2488c25a > < div class ="container " data-v-2488c25a > < button class ="menu " aria-expanded ="false " aria-controls ="VPSidebarNav " data-v-2488c25a > < span class ="vpi-align-left menu-icon " data-v-2488c25a > </ span > < span class ="menu-text " data-v-2488c25a > Menu</ span > </ button > < div class ="VPLocalNavOutlineDropdown " style ="--vp-vh:0px; " data-v-2488c25a data-v-6b867909 > < button data-v-6b867909 > Return to top</ button > <!----> </ div > </ div > </ div > < aside class ="VPSidebar " data-v-d8b57b2d data-v-42c4c606 > < div class ="curtain " data-v-42c4c606 > </ div > < nav class ="nav " id ="VPSidebarNav " aria-labelledby ="sidebar-aria-label " tabindex ="-1 " data-v-42c4c606 > < span class ="visually-hidden " id ="sidebar-aria-label " data-v-42c4c606 > Sidebar Navigation </ span > <!--[--> <!--]--> <!--[--> < div class ="no-transition group " data-v-51288d80 > < section class ="VPSidebarItem level-0 " data-v-51288d80 data-v-0009425e > <!----> < div class ="items " data-v-0009425e > <!--[--> < div class ="VPSidebarItem level-1 is-link " data-v-0009425e data-v-0009425e > < div class ="item " data-v-0009425e > < div class ="indicator " data-v-0009425e > </ div > < a class ="VPLink link link " href ="/getting-started.html " data-v-0009425e > <!--[--> < p class ="text " data-v-0009425e > Getting Started</ p > <!--]--> </ a > <!----> </ div > <!----> </ div > < div class ="VPSidebarItem level-1 is-link " data-v-0009425e data-v-0009425e > < div class ="item " data-v-0009425e > < div class ="indicator " data-v-0009425e > </ div > < a class ="VPLink link link " href ="/cron-syntax.html " data-v-0009425e > <!--[--> < p class ="text " data-v-0009425e > Cron Syntax</ p > <!--]--> </ a > <!----> </ div > <!----> </ div > < div class ="VPSidebarItem level-1 is-link " data-v-0009425e data-v-0009425e > < div class ="item " data-v-0009425e > < div class ="indicator " data-v-0009425e > </ div > < a class ="VPLink link link " href ="/background-tasks.html " data-v-0009425e > <!--[--> < p class ="text " data-v-0009425e > Background Tasks</ p > <!--]--> </ a > <!----> </ div > <!----> </ div > <!--]--> </ div > </ section > </ div > <!--]--> <!--[--> <!--]--> </ nav > </ aside > < div class ="VPContent has-sidebar " id ="VPContent " data-v-d8b57b2d data-v-9a6c75ad > < div class ="VPDoc has-sidebar has-aside " data-v-9a6c75ad data-v-e6f2a212 > <!--[--> <!--]--> < div class ="container " data-v-e6f2a212 > < div class ="aside " data-v-e6f2a212 > < div class ="aside-curtain " data-v-e6f2a212 > </ div > < div class ="aside-container " data-v-e6f2a212 > < div class ="aside-content " data-v-e6f2a212 > < div class ="VPDocAside " data-v-e6f2a212 data-v-cb998dce > <!--[--> <!--]--> <!--[--> <!--]--> < nav aria-labelledby ="doc-outline-aria-label " class ="VPDocAsideOutline " data-v-cb998dce data-v-f610f197 > < div class ="content " data-v-f610f197 > < div class ="outline-marker " data-v-f610f197 > </ div > < div aria-level ="2 " class ="outline-title " id ="doc-outline-aria-label " role ="heading " data-v-f610f197 > On this page</ div > < ul class ="VPDocOutlineItem root " data-v-f610f197 data-v-53c99d69 > <!--[--> <!--]--> </ ul > </ div > </ nav > <!--[--> <!--]--> < div class ="spacer " data-v-cb998dce > </ div > <!--[--> <!--]--> <!----> <!--[--> <!--]--> <!--[--> <!--]--> </ div > </ div > </ div > </ div > < div class ="content " data-v-e6f2a212 > < div class ="content-container " data-v-e6f2a212 > <!--[--> <!--]--> < main class ="main " data-v-e6f2a212 > < div style ="position:relative; " class ="vp-doc _api-examples " data-v-e6f2a212 > < div > < h1 id ="runtime-api-examples " tabindex ="-1 "> Runtime API Examples < a class ="header-anchor " href ="#runtime-api-examples " aria-label ="Permalink to "Runtime API Examples" "> </ a > </ h1 > < p > This page demonstrates usage of some of the runtime APIs provided by VitePress.</ p > < p > The main < code > useData()</ code > API can be used to access site, theme, and page data for the current page. It works in both < code > .md</ code > and < code > .vue</ code > files:</ p > < div class ="language-md vp-adaptive-theme "> < button title ="Copy Code " class ="copy "> </ button > < span class ="lang "> md</ span > < pre class ="shiki shiki-themes github-light github-dark vp-code " tabindex ="0 "> < code > < span class ="line "> < span style ="--shiki-light:#24292E;--shiki-dark:#E1E4E8; "> <script setup></ span > </ span >
22+ < span class ="line "> < span style ="--shiki-light:#24292E;--shiki-dark:#E1E4E8; "> import { useData } from 'vitepress'</ span > </ span >
23+ < span class ="line "> </ span >
24+ < span class ="line "> < span style ="--shiki-light:#24292E;--shiki-dark:#E1E4E8; "> const { theme, page, frontmatter } = useData()</ span > </ span >
25+ < span class ="line "> < span style ="--shiki-light:#24292E;--shiki-dark:#E1E4E8; "> </script></ span > </ span >
26+ < span class ="line "> </ span >
27+ < span class ="line "> < span style ="--shiki-light:#005CC5;--shiki-light-font-weight:bold;--shiki-dark:#79B8FF;--shiki-dark-font-weight:bold; "> ## Results</ span > </ span >
28+ < span class ="line "> </ span >
29+ < span class ="line "> < span style ="--shiki-light:#005CC5;--shiki-light-font-weight:bold;--shiki-dark:#79B8FF;--shiki-dark-font-weight:bold; "> ### Theme Data</ span > </ span >
30+ < span class ="line "> < span style ="--shiki-light:#24292E;--shiki-dark:#E1E4E8; "> <pre>{{ theme }}</pre></ span > </ span >
31+ < span class ="line "> </ span >
32+ < span class ="line "> < span style ="--shiki-light:#005CC5;--shiki-light-font-weight:bold;--shiki-dark:#79B8FF;--shiki-dark-font-weight:bold; "> ### Page Data</ span > </ span >
33+ < span class ="line "> < span style ="--shiki-light:#24292E;--shiki-dark:#E1E4E8; "> <pre>{{ page }}</pre></ span > </ span >
34+ < span class ="line "> </ span >
35+ < span class ="line "> < span style ="--shiki-light:#005CC5;--shiki-light-font-weight:bold;--shiki-dark:#79B8FF;--shiki-dark-font-weight:bold; "> ### Page Frontmatter</ span > </ span >
36+ < span class ="line "> < span style ="--shiki-light:#24292E;--shiki-dark:#E1E4E8; "> <pre>{{ frontmatter }}</pre></ span > </ span > </ code > </ pre > </ div > < h2 id ="results " tabindex ="-1 "> Results < a class ="header-anchor " href ="#results " aria-label ="Permalink to "Results" "> </ a > </ h2 > < h3 id ="theme-data " tabindex ="-1 "> Theme Data < a class ="header-anchor " href ="#theme-data " aria-label ="Permalink to "Theme Data" "> </ a > </ h3 > < pre > {
37+ "nav": [
38+ {
39+ "text": "Home",
40+ "link": "/"
41+ },
42+ {
43+ "text": "Getting Started",
44+ "link": "/getting-started"
45+ }
46+ ],
47+ "sidebar": [
48+ {
49+ "items": [
50+ {
51+ "text": "Getting Started",
52+ "link": "/getting-started"
53+ },
54+ {
55+ "text": "Cron Syntax",
56+ "link": "/cron-syntax"
57+ },
58+ {
59+ "text": "Background Tasks",
60+ "link": "/background-tasks"
61+ }
62+ ]
63+ }
64+ ],
65+ "socialLinks": [
66+ {
67+ "icon": "npm",
68+ "link": "https://www.npmjs.com/package/node-cron"
69+ },
70+ {
71+ "icon": "github",
72+ "link": "https://github.com/noce-cron/node-cron"
73+ }
74+ ],
75+ "markdown": {
76+ "toc": {
77+ "level": [
78+ 2,
79+ 3,
80+ 4
81+ ]
82+ }
83+ }
84+ }</ pre > < h3 id ="page-data " tabindex ="-1 "> Page Data < a class ="header-anchor " href ="#page-data " aria-label ="Permalink to "Page Data" "> </ a > </ h3 > < pre > {
85+ "title": "Runtime API Examples",
86+ "description": "",
87+ "frontmatter": {
88+ "outline": "deep"
89+ },
90+ "headers": [],
91+ "relativePath": "api-examples.md",
92+ "filePath": "api-examples.md"
93+ }</ pre > < h3 id ="page-frontmatter " tabindex ="-1 "> Page Frontmatter < a class ="header-anchor " href ="#page-frontmatter " aria-label ="Permalink to "Page Frontmatter" "> </ a > </ h3 > < pre > {
94+ "outline": "deep"
95+ }</ pre > < h2 id ="more " tabindex ="-1 "> More < a class ="header-anchor " href ="#more " aria-label ="Permalink to "More" "> </ a > </ h2 > < p > Check out the documentation for the < a href ="https://vitepress.dev/reference/runtime-api#usedata " target ="_blank " rel ="noreferrer "> full list of runtime APIs</ a > .</ p > </ div > </ div > </ main > < footer class ="VPDocFooter " data-v-e6f2a212 data-v-1bcd8184 > <!--[--> <!--]--> <!----> < nav class ="prev-next " aria-labelledby ="doc-footer-aria-label " data-v-1bcd8184 > < span class ="visually-hidden " id ="doc-footer-aria-label " data-v-1bcd8184 > Pager</ span > < div class ="pager " data-v-1bcd8184 > <!----> </ div > < div class ="pager " data-v-1bcd8184 > < a class ="VPLink link pager-link next " href ="/getting-started.html " data-v-1bcd8184 > <!--[--> < span class ="desc " data-v-1bcd8184 > Next page</ span > < span class ="title " data-v-1bcd8184 > Getting Started</ span > <!--]--> </ a > </ div > </ nav > </ footer > <!--[--> <!--]--> </ div > </ div > </ div > <!--[--> <!--]--> </ div > </ div > <!----> <!--[--> <!--]--> </ div > </ div >
96+ < script > window . __VP_HASH_MAP__ = JSON . parse ( "{\"api-examples.md\":\"CRRh3xeI\",\"background-tasks.md\":\"DFu97nTT\",\"cron-syntax.md\":\"zdOzM6TB\",\"getting-started.md\":\"CbOcXioC\",\"index.md\":\"CLPm8eBb\"}" ) ; window . __VP_SITE_DATA__ = JSON . parse ( "{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Node-Cron\",\"description\":\"A Lightweight Task Scheduler for Node.js\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Getting Started\",\"link\":\"/getting-started\"}],\"sidebar\":[{\"items\":[{\"text\":\"Getting Started\",\"link\":\"/getting-started\"},{\"text\":\"Cron Syntax\",\"link\":\"/cron-syntax\"},{\"text\":\"Background Tasks\",\"link\":\"/background-tasks\"}]}],\"socialLinks\":[{\"icon\":\"npm\",\"link\":\"https://www.npmjs.com/package/node-cron\"},{\"icon\":\"github\",\"link\":\"https://github.com/noce-cron/node-cron\"}],\"markdown\":{\"toc\":{\"level\":[2,3,4]}}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}" ) ; </ script >
97+
98+ </ body >
99+ </ html >
0 commit comments