working-days.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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>Working Days | Chinese Days</title>
  7. <meta name="description" content="A VitePress Site">
  8. <meta name="generator" content="VitePress v1.5.0">
  9. <link rel="preload stylesheet" href="/assets/style.Bay9p7sf.css" as="style">
  10. <link rel="preload stylesheet" href="/vp-icons.css" as="style">
  11. <script type="module" src="/assets/app.CJ-7HXbO.js"></script>
  12. <link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
  13. <link rel="modulepreload" href="/assets/chunks/theme.CVLCVZqY.js">
  14. <link rel="modulepreload" href="/assets/chunks/framework.BI-rd6Wj.js">
  15. <link rel="modulepreload" href="/assets/en_guide_working-days.md.DYJ7dxHr.lean.js">
  16. <link rel="icon" type="image/png" href="/icon.png">
  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",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
  19. </head>
  20. <body>
  21. <div id="app"><div class="Layout" data-v-d8b57b2d><!--[--><!--]--><!--[--><span tabindex="-1" data-v-c8291ffa></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-c8291ffa> 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="/en/" data-v-9f43907a><!--[--><!--]--><!--[--><img class="VPImage logo" src="/icon.png" width="24" height="24" alt data-v-ab19afbb><!--]--><span data-v-9f43907a>Chinese Days</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 id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></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="/en/guide/what-is-chinese-days.html" tabindex="0" data-v-afb2845e data-v-815115f5><!--[--><span data-v-815115f5>Guide</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/demo/calendar.html" tabindex="0" data-v-afb2845e data-v-815115f5><!--[--><span data-v-815115f5>Demo</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/vsme/chinese-days/blob/main/CHANGELOG.md" target="_blank" rel="noreferrer" tabindex="0" data-v-afb2845e data-v-815115f5><!--[--><span data-v-815115f5>1.4.0</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-9fd4d1dd data-v-acee064b data-v-bfe7971f><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Change language" data-v-bfe7971f><span class="text" data-v-bfe7971f><span class="vpi-languages option-icon" data-v-bfe7971f></span><!----><span class="vpi-chevron-down text-icon" data-v-bfe7971f></span></span></button><div class="menu" data-v-bfe7971f><div class="VPMenu" data-v-bfe7971f data-v-20ed86d6><!----><!--[--><!--[--><div class="items" data-v-acee064b><p class="title" data-v-acee064b>English</p><!--[--><div class="VPMenuLink" data-v-acee064b data-v-7eeeb2dc><a class="VPLink link" href="/guide/working-days.html" data-v-7eeeb2dc><!--[--><span data-v-7eeeb2dc>简体中文</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><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://github.com/vsme/chinese-days" 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 translations" data-v-f953d92f><p class="trans-title" data-v-f953d92f>English</p><!--[--><div class="VPMenuLink" data-v-f953d92f data-v-7eeeb2dc><a class="VPLink link" href="/guide/working-days.html" data-v-7eeeb2dc><!--[--><span data-v-7eeeb2dc>简体中文</span><!--]--></a></div><!--]--></div><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://github.com/vsme/chinese-days" 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-883964e0><button data-v-883964e0>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 collapsible" data-v-51288d80 data-v-edd2eed8><div class="item" role="button" tabindex="0" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><h2 class="text" data-v-edd2eed8>Introduction</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-edd2eed8><span class="vpi-chevron-right caret-icon" data-v-edd2eed8></span></div></div><div class="items" data-v-edd2eed8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/what-is-chinese-days.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>What is Chinese Days</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/ical-subscription.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>iCal Subscription</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/getting-started.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Getting started</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0 collapsible has-active" data-v-51288d80 data-v-edd2eed8><div class="item" role="button" tabindex="0" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><h2 class="text" data-v-edd2eed8>Holidays</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-edd2eed8><span class="vpi-chevron-right caret-icon" data-v-edd2eed8></span></div></div><div class="items" data-v-edd2eed8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/holidays.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Holidays</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/lieu-days.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Lieu Days</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/working-days.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Working Days</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0 collapsible" data-v-51288d80 data-v-edd2eed8><div class="item" role="button" tabindex="0" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><h2 class="text" data-v-edd2eed8>24 Solar Terms</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-edd2eed8><span class="vpi-chevron-right caret-icon" data-v-edd2eed8></span></div></div><div class="items" data-v-edd2eed8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/24-solar-terms.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Apis</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0 collapsible" data-v-51288d80 data-v-edd2eed8><div class="item" role="button" tabindex="0" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><h2 class="text" data-v-edd2eed8>Lunar</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-edd2eed8><span class="vpi-chevron-right caret-icon" data-v-edd2eed8></span></div></div><div class="items" data-v-edd2eed8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/to-lunar.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Solar to Lunar</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/from-lunar.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Lunar to Solar</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/lunar-folk-festival.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Lunar Folk Festival</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0 collapsible" data-v-51288d80 data-v-edd2eed8><div class="item" role="button" tabindex="0" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><h2 class="text" data-v-edd2eed8>Else</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-edd2eed8><span class="vpi-chevron-right caret-icon" data-v-edd2eed8></span></div></div><div class="items" data-v-edd2eed8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/contributing.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Contributing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/en/guide/thank.html" data-v-edd2eed8><!--[--><p class="text" data-v-edd2eed8>Thank</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 _en_guide_working-days" data-v-e6f2a212><div><h1 id="working-days" tabindex="-1">Working Days <a class="header-anchor" href="#working-days" aria-label="Permalink to &quot;Working Days&quot;">​</a></h1><h2 id="isworkday-check-if-a-given-date-is-a-workday" tabindex="-1"><code>isWorkday</code> Check if a given date is a workday <a class="header-anchor" href="#isworkday-check-if-a-given-date-is-a-workday" aria-label="Permalink to &quot;`isWorkday` Check if a given date is a workday&quot;">​</a></h2><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</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;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">isWorkday</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;2023-01-01&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)); </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// false</span></span></code></pre></div><h2 id="getworkdaysinrange-get-a-list-of-workdays-within-a-specified-date-range" tabindex="-1"><code>getWorkdaysInRange</code> Get a list of workdays within a specified date range <a class="header-anchor" href="#getworkdaysinrange-get-a-list-of-workdays-within-a-specified-date-range" aria-label="Permalink to &quot;`getWorkdaysInRange` Get a list of workdays within a specified date range&quot;">​</a></h2><p>This function takes a start date, an end date, and an optional parameter to decide whether to include weekends. If weekends are included, the function returns all days within the range. Otherwise, it returns only weekdays (Monday to Friday).</p><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Example usage</span></span>
  22. <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> start</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;2024-04-26&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
  23. <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> end</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;2024-05-06&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
  24. <span class="line"></span>
  25. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Get all workdays from 2024-04-26 to 2024-05-06, including weekends</span></span>
  26. <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> workdaysIncludingWeekends</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> getWorkdaysInRange</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(start, end, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
  27. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;Workdays including weekends:&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, workdaysIncludingWeekends);</span></span>
  28. <span class="line"></span>
  29. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Get workdays from 2024-04-26 to 2024-05-06, excluding weekends</span></span>
  30. <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> workdaysExcludingWeekends</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> getWorkdaysInRange</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(start, end, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">false</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
  31. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;Workdays excluding weekends:&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, workdaysExcludingWeekends);</span></span></code></pre></div><h2 id="findworkday-find-a-workday" tabindex="-1"><code>findWorkday</code> Find a workday <a class="header-anchor" href="#findworkday-find-a-workday" aria-label="Permalink to &quot;`findWorkday` Find a workday&quot;">​</a></h2><p>Find the <code>{deltaDays}</code>-th workday starting from today.</p><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Find the {deltaDays}-th workday from today</span></span>
  32. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// If deltaDays is 0, first check if today is a workday. If yes, return today&#39;s date.</span></span>
  33. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// If today is not a workday, find the next workday.</span></span>
  34. <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> currentWorkday</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> findWorkday</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
  35. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(currentWorkday);</span></span>
  36. <span class="line"></span>
  37. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Find the next workday</span></span>
  38. <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> nextWorkday</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> findWorkday</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
  39. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(nextWorkday);</span></span>
  40. <span class="line"></span>
  41. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Find the previous workday</span></span>
  42. <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> previousWorkday</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> findWorkday</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">-</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
  43. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(previousWorkday);</span></span>
  44. <span class="line"></span>
  45. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Specify a starting date to find workdays relative to it</span></span>
  46. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Find the second workday from 2024-05-18</span></span>
  47. <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> secondNextWorkday</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> findWorkday</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">2</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;2024-05-18&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
  48. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(secondNextWorkday);</span></span></code></pre></div><h2 id="getdaydetail-get-detailed-date-information" tabindex="-1"><code>getDayDetail</code> Get detailed date information <a class="header-anchor" href="#getdaydetail-get-detailed-date-information" aria-label="Permalink to &quot;`getDayDetail` Get detailed date information&quot;">​</a></h2><p>This function checks if a specified date is a workday and returns a boolean indicating whether it is a workday, along with details about the date.</p><ol><li>If the specified date is a workday, it returns <code>true</code> and the name of the weekday. If it is a rescheduled workday (due to holiday adjustments), it returns <code>true</code> and details about the holiday.</li><li>If it is a holiday, it returns <code>false</code> and holiday details.</li></ol><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Example usage</span></span>
  49. <span class="line"></span>
  50. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// A regular workday (Friday)</span></span>
  51. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getDayDetail</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;2024-02-02&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)); </span></span>
  52. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// { &quot;date&quot;: &quot;2024-02-02&quot;, &quot;work&quot;: true, &quot;name&quot;: &quot;Friday&quot; }</span></span>
  53. <span class="line"></span>
  54. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// A holiday (weekend)</span></span>
  55. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getDayDetail</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;2024-02-03&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)); </span></span>
  56. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// { &quot;date&quot;: &quot;2024-02-03&quot;, &quot;work&quot;: false, &quot;name&quot;: &quot;Saturday&quot; }</span></span>
  57. <span class="line"></span>
  58. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// A rescheduled workday</span></span>
  59. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getDayDetail</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;2024-02-04&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)); </span></span>
  60. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// { &quot;date&quot;: &quot;2024-02-04&quot;, &quot;work&quot;: true, &quot;name&quot;: &quot;Spring Festival, 春节, 3&quot; }</span></span>
  61. <span class="line"></span>
  62. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// A Spring Festival holiday</span></span>
  63. <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getDayDetail</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;2024-02-17&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)); </span></span>
  64. <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// { &quot;date&quot;: &quot;2024-02-17&quot;, &quot;work&quot;: false, &quot;name&quot;: &quot;Spring Festival, 春节, 3&quot; }</span></span></code></pre></div></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><a class="VPLink link pager-link prev" href="/en/guide/lieu-days.html" data-v-1bcd8184><!--[--><span class="desc" data-v-1bcd8184>Previous page</span><span class="title" data-v-1bcd8184>Lieu Days</span><!--]--></a></div><div class="pager" data-v-1bcd8184><a class="VPLink link pager-link next" href="/en/guide/24-solar-terms.html" data-v-1bcd8184><!--[--><span class="desc" data-v-1bcd8184>Next page</span><span class="title" data-v-1bcd8184>Apis</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-d8b57b2d data-v-566314d4><div class="container" data-v-566314d4><p class="message" data-v-566314d4>Released under the MIT License.</p><p class="copyright" data-v-566314d4>Copyright © 2024-present Yawei Sun</p></div></footer><!--[--><!--]--></div></div>
  65. <script>window.__VP_HASH_MAP__=JSON.parse("{\"demo_calendar.md\":\"3Yva2Hba\",\"en_demo_calendar.md\":\"Dcb_4E0o\",\"en_guide_24-solar-terms.md\":\"C20wFIAR\",\"en_guide_contributing.md\":\"B-IUTNxY\",\"en_guide_from-lunar.md\":\"DD6CyQyV\",\"en_guide_getting-started.md\":\"DRb__Xdz\",\"en_guide_holidays.md\":\"b8XSxqBO\",\"en_guide_ical-subscription.md\":\"mJtdY6jL\",\"en_guide_lieu-days.md\":\"MIpvwAW1\",\"en_guide_lunar-folk-festival.md\":\"DaEDAwv4\",\"en_guide_thank.md\":\"DqWO0lBt\",\"en_guide_to-lunar.md\":\"BOqjA_uw\",\"en_guide_what-is-chinese-days.md\":\"B6jPeNtr\",\"en_guide_working-days.md\":\"DYJ7dxHr\",\"en_index.md\":\"DtOcB7xz\",\"guide_24-solar-terms.md\":\"DZT2Ulrn\",\"guide_contributing.md\":\"BcLL51JL\",\"guide_from-lunar.md\":\"wYbK_e8i\",\"guide_getting-started.md\":\"Bp4vyrpW\",\"guide_holidays.md\":\"CDlVJeTE\",\"guide_ical-subscription.md\":\"BgU00myJ\",\"guide_lieu-days.md\":\"mMLUu5GV\",\"guide_lunar-folk-festival.md\":\"RA2VPANX\",\"guide_thank.md\":\"CbXQhjBx\",\"guide_to-lunar.md\":\"q-gsFQuj\",\"guide_what-is-chinese-days.md\":\"CpNK66Mb\",\"guide_working-days.md\":\"DiX-UlWg\",\"index.md\":\"B6irBDIq\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Chinese Days\",\"description\":\"A VitePress site\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":{\"src\":\"/icon.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\"}},\"locales\":{\"root\":{\"label\":\"简体中文\",\"description\":\"A VitePress Site\",\"themeConfig\":{\"nav\":[{\"text\":\"指南\",\"link\":\"/guide/what-is-chinese-days\"},{\"text\":\"示例\",\"link\":\"/demo/calendar\"},{\"text\":\"1.4.0\",\"link\":\"https://github.com/vsme/chinese-days/blob/main/CHANGELOG.md\"}],\"sidebar\":{\"/guide/\":{\"base\":\"/guide/\",\"items\":[{\"text\":\"简介\",\"collapsed\":false,\"items\":[{\"text\":\"关于本项目\",\"link\":\"what-is-chinese-days\"},{\"text\":\"日历订阅\",\"link\":\"ical-subscription\"},{\"text\":\"快速开始\",\"link\":\"getting-started\"}]},{\"text\":\"节假日\",\"collapsed\":false,\"items\":[{\"text\":\"节假日\",\"link\":\"holidays\"},{\"text\":\"调休日\",\"link\":\"lieu-days\"},{\"text\":\"工作日\",\"link\":\"working-days\"}]},{\"text\":\"24节气\",\"collapsed\":false,\"items\":[{\"text\":\"使用方法\",\"link\":\"24-solar-terms\"}]},{\"text\":\"农历(阴历)\",\"collapsed\":false,\"items\":[{\"text\":\"阳历转农历\",\"link\":\"to-lunar\"},{\"text\":\"农历转阳历\",\"link\":\"from-lunar\"},{\"text\":\"民俗节日与纪念日\",\"link\":\"lunar-folk-festival\"}]},{\"text\":\"其他\",\"collapsed\":false,\"items\":[{\"text\":\"贡献指南\",\"link\":\"contributing\"},{\"text\":\"致谢\",\"link\":\"thank\"}]}]},\"/demo/\":{\"base\":\"/demo/\",\"items\":[{\"text\":\"使用示例\",\"items\":[{\"text\":\"日历\",\"link\":\"calendar\"}]}]}},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/vsme/chinese-days\"}],\"footer\":{\"message\":\"基于 MIT 许可发布\",\"copyright\":\"Copyright © 2019-2025 Yawei Sun\"},\"docFooter\":{\"prev\":\"上一页\",\"next\":\"下一页\"},\"outline\":{\"label\":\"页面导航\"},\"lastUpdated\":{\"text\":\"最后更新于\",\"formatOptions\":{\"dateStyle\":\"short\",\"timeStyle\":\"medium\"}},\"langMenuLabel\":\"多语言\",\"returnToTopLabel\":\"回到顶部\",\"sidebarMenuLabel\":\"菜单\",\"darkModeSwitchLabel\":\"主题\",\"lightModeSwitchTitle\":\"切换到浅色模式\",\"darkModeSwitchTitle\":\"切换到深色模式\"}},\"en\":{\"label\":\"English\",\"description\":\"A VitePress Site\",\"themeConfig\":{\"nav\":[{\"text\":\"Guide\",\"link\":\"/en/guide/what-is-chinese-days\"},{\"text\":\"Demo\",\"link\":\"/en/demo/calendar\"},{\"text\":\"1.4.0\",\"link\":\"https://github.com/vsme/chinese-days/blob/main/CHANGELOG.md\"}],\"sidebar\":{\"/en/guide/\":{\"base\":\"/en/guide/\",\"items\":[{\"text\":\"Introduction\",\"collapsed\":false,\"items\":[{\"text\":\"What is Chinese Days\",\"link\":\"what-is-chinese-days\"},{\"text\":\"iCal Subscription\",\"link\":\"ical-subscription\"},{\"text\":\"Getting started\",\"link\":\"getting-started\"}]},{\"text\":\"Holidays\",\"collapsed\":false,\"items\":[{\"text\":\"Holidays\",\"link\":\"holidays\"},{\"text\":\"Lieu Days\",\"link\":\"lieu-days\"},{\"text\":\"Working Days\",\"link\":\"working-days\"}]},{\"text\":\"24 Solar Terms\",\"collapsed\":false,\"items\":[{\"text\":\"Apis\",\"link\":\"24-solar-terms\"}]},{\"text\":\"Lunar\",\"collapsed\":false,\"items\":[{\"text\":\"Solar to Lunar\",\"link\":\"to-lunar\"},{\"text\":\"Lunar to Solar\",\"link\":\"from-lunar\"},{\"text\":\"Lunar Folk Festival\",\"link\":\"lunar-folk-festival\"}]},{\"text\":\"Else\",\"collapsed\":false,\"items\":[{\"text\":\"Contributing\",\"link\":\"contributing\"},{\"text\":\"Thank\",\"link\":\"thank\"}]}]},\"/en/demo/\":{\"base\":\"/en/demo/\",\"items\":[{\"text\":\"Demo\",\"items\":[{\"text\":\"Calendar\",\"link\":\"calendar\"}]}]}},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/vsme/chinese-days\"}],\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2024-present Yawei Sun\"}}}},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
  66. </body>
  67. </html>