Skip to content

Commit 9f298c7

Browse files
Deploying to site from @ 0eb015d 🚀
1 parent 77d32b7 commit 9f298c7

File tree

8 files changed

+308
-4
lines changed

8 files changed

+308
-4
lines changed
Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>Companion</title>
6+
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../../../styles/style.css" rel="Stylesheet">
25+
<link href="../../../../styles/main.css" rel="Stylesheet">
26+
<link href="../../../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<link href="../../../../ui-kit/ui-kit.min.css" rel="Stylesheet">
30+
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
31+
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
32+
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
33+
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
34+
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
35+
<script type="text/javascript" src="../../../../ui-kit/ui-kit.min.js" defer="defer"></script>
36+
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
37+
</head>
38+
<body>
39+
<div class="root">
40+
<nav class="navigation theme-dark" id="navigation-wrapper">
41+
<a class="library-name--link" href="../../../../index.html">
42+
cardiologist
43+
</a>
44+
<button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle"
45+
type="button">Toggle table of contents
46+
</button>
47+
<div class="navigation-controls--break ui-kit_mobile-only"></div>
48+
<div class="library-version" id="library-version">
49+
</div>
50+
<div class="navigation-controls">
51+
<div class="filter-section filter-section_loading" id="filter-section">
52+
<button class="platform-tag platform-selector common-like" data-active=""
53+
data-filter=":/commonMain">common</button>
54+
<div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
55+
<button class="button button_dropdown filter-section--dropdown-toggle" role="combobox"
56+
data-role="dropdown-toggle"
57+
aria-controls="platform-tags-listbox"
58+
aria-haspopup="listbox"
59+
aria-expanded="false"
60+
aria-label="Toggle source sets"
61+
></button>
62+
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox">
63+
<div class="dropdown--header"><span>Platform filter</span>
64+
<button class="button" data-role="dropdown-toggle" aria-label="Close platform filter">
65+
<i class="ui-kit-icon ui-kit-icon_cross"></i>
66+
</button>
67+
</div>
68+
<li role="option" class="dropdown--option platform-selector-option common-like" tabindex="0">
69+
<label class="checkbox">
70+
<input type="checkbox" class="checkbox--input" id=":/commonMain"
71+
data-filter=":/commonMain"/>
72+
<span class="checkbox--icon"></span>
73+
common
74+
</label>
75+
</li>
76+
</ul>
77+
<div class="dropdown--overlay"></div>
78+
</div>
79+
</div>
80+
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button"
81+
type="button">Switch theme
82+
</button>
83+
<div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
84+
API
85+
</div>
86+
</div>
87+
</nav>
88+
<div id="container">
89+
<div class="sidebar" id="leftColumn">
90+
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
91+
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list"
92+
data-role="dropdown-listbox">
93+
<div class="dropdown--header">
94+
<span>
95+
cardiologist
96+
</span>
97+
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
98+
<i class="ui-kit-icon ui-kit-icon_cross"></i>
99+
</button>
100+
</div>
101+
<div class="sidebar--inner" id="sideMenu"></div>
102+
</ul>
103+
<div class="dropdown--overlay"></div>
104+
</div>
105+
</div>
106+
<div id="main">
107+
<div class="main-content" data-page-type="classlike" id="content" pageIds="cardiologist::io.github.kevincianfarini.cardiologist/PulseSchedule.Companion///PointingToDeclaration//1558683979">
108+
<div class="breadcrumbs"><a href="../../../../index.html">cardiologist</a><span class="delimiter">/</span><a href="../../index.html">io.github.kevincianfarini.cardiologist</a><span class="delimiter">/</span><a href="../index.html">PulseSchedule</a><span class="delimiter">/</span><span class="current">Companion</span></div>
109+
<div class="cover ">
110+
<h1 class="cover"><span><span>Companion</span></span></h1>
111+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a></div></div></div>
112+
</div>
113+
<div class="tabbedcontent">
114+
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
115+
<div class="tabs-section-body">
116+
<div data-togglable="FUNCTION">
117+
<h2 class="">Functions</h2>
118+
<div class="table"><a data-name="-1119357116%2FFunctions%2F1558683979" anchor-label="parseCron" id="-1119357116%2FFunctions%2F1558683979" data-filterable-set=":/commonMain"></a>
119+
<div class="table-row" data-filterable-current=":/commonMain" data-filterable-set=":/commonMain">
120+
<div class="main-subrow keyValue ">
121+
<div class=""><span class="inline-flex">
122+
<div><a href="parse-cron.html"><span>parse</span><wbr></wbr><span><span>Cron</span></span></a></div>
123+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1119357116%2FFunctions%2F1558683979"></span>
124+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
125+
</span></span></div>
126+
<div>
127+
<div class="title">
128+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="parse-cron.html"><span class="token function">parseCron</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">expression<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">PulseSchedule</a></div><div class="brief "><p class="paragraph">Parse a cron <a href="parse-cron.html">expression</a> into a <a href="../index.html">PulseSchedule</a>.</p></div></div></div>
129+
</div>
130+
</div>
131+
</div>
132+
</div>
133+
</div>
134+
</div>
135+
</div>
136+
</div>
137+
</div>
138+
<div class="footer">
139+
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
140+
<span>© 2025 Copyright</span>
141+
<span class="pull-right">
142+
<span>Generated by </span>
143+
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
144+
<span>dokka</span>
145+
</a>
146+
</span>
147+
</div>
148+
</div>
149+
</div>
150+
</div>
151+
</body>
152+
</html>
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>parseCron</title>
6+
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../../../styles/style.css" rel="Stylesheet">
25+
<link href="../../../../styles/main.css" rel="Stylesheet">
26+
<link href="../../../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<link href="../../../../ui-kit/ui-kit.min.css" rel="Stylesheet">
30+
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
31+
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
32+
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
33+
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
34+
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
35+
<script type="text/javascript" src="../../../../ui-kit/ui-kit.min.js" defer="defer"></script>
36+
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
37+
</head>
38+
<body>
39+
<div class="root">
40+
<nav class="navigation theme-dark" id="navigation-wrapper">
41+
<a class="library-name--link" href="../../../../index.html">
42+
cardiologist
43+
</a>
44+
<button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle"
45+
type="button">Toggle table of contents
46+
</button>
47+
<div class="navigation-controls--break ui-kit_mobile-only"></div>
48+
<div class="library-version" id="library-version">
49+
</div>
50+
<div class="navigation-controls">
51+
<div class="filter-section filter-section_loading" id="filter-section">
52+
<button class="platform-tag platform-selector common-like" data-active=""
53+
data-filter=":/commonMain">common</button>
54+
<div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
55+
<button class="button button_dropdown filter-section--dropdown-toggle" role="combobox"
56+
data-role="dropdown-toggle"
57+
aria-controls="platform-tags-listbox"
58+
aria-haspopup="listbox"
59+
aria-expanded="false"
60+
aria-label="Toggle source sets"
61+
></button>
62+
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox">
63+
<div class="dropdown--header"><span>Platform filter</span>
64+
<button class="button" data-role="dropdown-toggle" aria-label="Close platform filter">
65+
<i class="ui-kit-icon ui-kit-icon_cross"></i>
66+
</button>
67+
</div>
68+
<li role="option" class="dropdown--option platform-selector-option common-like" tabindex="0">
69+
<label class="checkbox">
70+
<input type="checkbox" class="checkbox--input" id=":/commonMain"
71+
data-filter=":/commonMain"/>
72+
<span class="checkbox--icon"></span>
73+
common
74+
</label>
75+
</li>
76+
</ul>
77+
<div class="dropdown--overlay"></div>
78+
</div>
79+
</div>
80+
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button"
81+
type="button">Switch theme
82+
</button>
83+
<div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
84+
API
85+
</div>
86+
</div>
87+
</nav>
88+
<div id="container">
89+
<div class="sidebar" id="leftColumn">
90+
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
91+
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list"
92+
data-role="dropdown-listbox">
93+
<div class="dropdown--header">
94+
<span>
95+
cardiologist
96+
</span>
97+
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
98+
<i class="ui-kit-icon ui-kit-icon_cross"></i>
99+
</button>
100+
</div>
101+
<div class="sidebar--inner" id="sideMenu"></div>
102+
</ul>
103+
<div class="dropdown--overlay"></div>
104+
</div>
105+
</div>
106+
<div id="main">
107+
<div class="main-content" data-page-type="member" id="content" pageIds="cardiologist::io.github.kevincianfarini.cardiologist/PulseSchedule.Companion/parseCron/#kotlin.String/PointingToDeclaration//1558683979">
108+
<div class="breadcrumbs"><a href="../../../../index.html">cardiologist</a><span class="delimiter">/</span><a href="../../index.html">io.github.kevincianfarini.cardiologist</a><span class="delimiter">/</span><a href="../index.html">PulseSchedule</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">parseCron</span></div>
109+
<div class="cover ">
110+
<h1 class="cover"><span>parse</span><wbr></wbr><span><span>Cron</span></span></h1>
111+
</div>
112+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="parse-cron.html"><span class="token function">parseCron</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">expression<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">PulseSchedule</a></div><p class="paragraph">Parse a cron <a href="parse-cron.html">expression</a> into a <a href="../index.html">PulseSchedule</a>.</p><p class="paragraph">This function supports the standard cron specification, which includes:</p><ul><li><p class="paragraph">Five fields specifying the minute, hour, day of month, month, and day of week.</p></li><li><p class="paragraph"><code class="lang-kotlin">*</code> denoting a wildcard value.</p></li><li><p class="paragraph">List of values using commas, like <code class="lang-kotlin">1,5,7</code>.</p></li><li><p class="paragraph">Ranges of values, like <code class="lang-kotlin">5-10</code>.</p></li><li><p class="paragraph">Mixed range and list values, like <code class="lang-kotlin">5-10,20-25</code>.</p></li><li><p class="paragraph">The integers 0-59 for the minute field.</p></li><li><p class="paragraph">The integers 0-23 for the hour field.</p></li><li><p class="paragraph">The integers 1-31 for the day of week field.</p></li><li><p class="paragraph">The integers 1-12 for the month field.</p></li><li><p class="paragraph">The integers 0-6 or strings SUN-SAT for the day of week field.</p></li></ul><p class="paragraph">Functionality not articulated above is considered non-standard and is therefore explicitly not supported.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":/commonMain" data-filterable-set=":/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html"><span>Illegal</span><wbr></wbr><span>Argument</span><wbr></wbr><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">Malformed cron expression or unsupported cron feature.</p></div></div></div></div></div></div></div>
113+
</div>
114+
<div class="footer">
115+
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
116+
<span>© 2025 Copyright</span>
117+
<span class="pull-right">
118+
<span>Generated by </span>
119+
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
120+
<span>dokka</span>
121+
</a>
122+
</span>
123+
</div>
124+
</div>
125+
</div>
126+
</div>
127+
</body>
128+
</html>

0 commit comments

Comments
 (0)