Skip to content

Commit 14f44ea

Browse files
committed
Examples
1 parent a0b0b47 commit 14f44ea

File tree

16 files changed

+242
-20
lines changed

16 files changed

+242
-20
lines changed

coverage.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"tests":68,"assertions":247,"lines":{"total":194,"covered":194,"skipped":0,"pct":100},"statements":{"total":224,"covered":224,"skipped":0,"pct":100},"functions":{"total":87,"covered":87,"skipped":0,"pct":100},"branches":{"total":73,"covered":73,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}
1+
{"tests":77,"assertions":268,"lines":{"total":194,"covered":194,"skipped":0,"pct":100},"statements":{"total":224,"covered":224,"skipped":0,"pct":100},"functions":{"total":87,"covered":87,"skipped":0,"pct":100},"branches":{"total":73,"covered":73,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}

docs/api/all.html

Lines changed: 77 additions & 3 deletions
Large diffs are not rendered by default.
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
<nav><ul><li><a href="/">TinyTick</a></li><li><a href="/api/">API</a></li><li><a href="/api/tinytick/"><code>tinytick</code></a></li><li><a href="/api/tinytick/functions/">Functions</a></li><li><a href="/api/tinytick/functions/creation/createmanager/"><code>createManager</code></a></li></ul></nav><section class="s1" id="/api/tinytick/functions/creation/createmanager/" data-id="cM"><h1><code>createManager</code></h1><p>The <code>createManager</code> function creates a <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>, and is the main entry point into the tinytick module.</p><pre><code><span class="function"><a href="/api/tinytick/functions/creation/createmanager/">createManager</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="/api/tinytick/interfaces/manager/manager/">Manager</a></span></code></pre><div class="table"><table><tr><th class="right">returns</th><td><code><span class="type"><a href="/api/tinytick/interfaces/manager/manager/">Manager</a></span></code></td><td><p></p><p>A new <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>.</p><p></p></td></tr></table></div><p>Once you have a reference to the <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>, you can start and stop it, register tasks and categories, and schedule task runs.</p><section class="s2"><h2>Since</h2><p>v1.0.0</p></section></section>
1+
<nav><ul><li><a href="/">TinyTick</a></li><li><a href="/api/">API</a></li><li><a href="/api/tinytick/"><code>tinytick</code></a></li><li><a href="/api/tinytick/functions/">Functions</a></li><li><a href="/api/tinytick/functions/creation/createmanager/"><code>createManager</code></a></li></ul></nav><section class="s1" id="/api/tinytick/functions/creation/createmanager/" data-id="cM"><h1><code>createManager</code></h1><p>The <code>createManager</code> function creates a <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>, and is the main entry point into the tinytick module.</p><pre><code><span class="function"><a href="/api/tinytick/functions/creation/createmanager/">createManager</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="/api/tinytick/interfaces/manager/manager/">Manager</a></span></code></pre><div class="table"><table><tr><th class="right">returns</th><td><code><span class="type"><a href="/api/tinytick/interfaces/manager/manager/">Manager</a></span></code></td><td><p></p><p>A new <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>.</p><p></p></td></tr></table></div><p>Once you have a reference to the <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>, you can start and stop it, register tasks and categories, and schedule task runs.</p><section class="s2"><h2>Example</h2><p>This example creates a <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a> object and gets its default configuration.</p><pre><code><span class="keyword">import</span> <span class="punctuation">{</span>createManager<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinytick'</span><span class="punctuation">;</span>
2+
3+
<span class="keyword">const</span> manager <span class="operator">=</span> <span class="function"><a href="/api/tinytick/functions/creation/createmanager/">createManager</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
4+
5+
console<span class="punctuation">.</span><span class="function">log</span><span class="punctuation">(</span>manager<span class="punctuation">.</span><span class="function"><a href="/api/tinytick/interfaces/manager/manager/methods/manager/getmanagerconfig/">getManagerConfig</a></span><span class="punctuation">(</span><span class="boolean">true</span><span class="punctuation">)</span><span class="punctuation">)</span><span class="punctuation">;</span>
6+
<span class="comment">// -> {tickInterval: 100}</span>
7+
</code></pre></section><section class="s2"><h2>Since</h2><p>v1.0.0</p></section></section>
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
<!DOCTYPE html><html lang="en"><head><link rel="dns-prefetch" href="https://www.googletagmanager.com/"><link href="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ" rel="preload" as="script"><link rel="preload" as="font" href="/fonts/inter.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/inconsolata.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/shantell.woff2" type="font/woff2" crossorigin="anonymous"><title>createManager | TinyTick</title><meta name="description" content="The createManager function creates a Manager, and is the main entry point into the tinytick module."><meta property="og:type" content="website"><meta property="og:title" content="createManager | TinyTick"><meta property="og:description" content="The createManager function creates a Manager, and is the main entry point into the tinytick module."><meta property="og:url" content="https://tinytick.org/api/tinytick/functions/creation/createmanager/"><meta property="og:image" content="https://tinytick.org/favicon_pad.png"><meta name="twitter:card" content="summary"><meta name="twitter:title" content="createManager | TinyTick"><meta name="twitter:description" content="The createManager function creates a Manager, and is the main entry point into the tinytick module."><meta name="twitter:site" content="@tinybasejs"><meta name="twitter:image" content="https://tinytick.org/favicon_pad.png"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" type="image/svg+xml" href="/favicon.svg"><link rel="stylesheet" href="/css/index.css"><link rel="canonical" href="https://tinytick.org/api/tinytick/functions/creation/createmanager/"><script src="/js/app.js"></script></head><body><header><a href="/"><img src="/favicon.svg" alt="TinyTick logo"><span>TinyTick</span></a><nav><ul><li><a href="/guides/">Guides</a></li><li><a href="/demos/">Demos</a></li><li><a href="/api/">API</a></li><li><a href="https://github.com/tinyplex/tinytick">GitHub</a></li></ul></nav><span id="dark"></span></header><main><nav><ul><li id="root" class="parent open"><span></span><a href="/">TinyTick</a><ul><li id="G" class="parent"><span></span><a href="/guides/">Guides</a></li><li id="D" class="parent"><span></span><a href="/demos/">Demos</a></li><li id="api" class="parent open"><span></span><a href="/api/">API</a><ul><li id="t" class="parent open"><span></span><a href="/api/tinytick/"><code>tinytick</code></a><ul><li id="t/I" class="parent"><span></span><a href="/api/tinytick/interfaces/">Interfaces</a></li><li id="t/F" class="parent open"><span></span><a href="/api/tinytick/functions/">Functions</a><ul><li id="cM" class="current"><span></span><a href="/api/tinytick/functions/creation/createmanager/"><code>createManager</code></a></li></ul></li><li id="t/TA" class="parent"><span></span><a href="/api/tinytick/type-aliases/">Type Aliases</a></li></ul></li></ul></li></ul></li></ul></nav><article><nav><ul><li><a href="/">TinyTick</a></li><li><a href="/api/">API</a></li><li><a href="/api/tinytick/"><code>tinytick</code></a></li><li><a href="/api/tinytick/functions/">Functions</a></li><li><a href="/api/tinytick/functions/creation/createmanager/"><code>createManager</code></a></li></ul></nav><section class="s1" id="/api/tinytick/functions/creation/createmanager/" data-id="cM"><h1><code>createManager</code></h1><p>The <code>createManager</code> function creates a <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>, and is the main entry point into the tinytick module.</p><pre><code><span class="function"><a href="/api/tinytick/functions/creation/createmanager/">createManager</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="/api/tinytick/interfaces/manager/manager/">Manager</a></span></code></pre><div class="table"><table><tr><th class="right">returns</th><td><code><span class="type"><a href="/api/tinytick/interfaces/manager/manager/">Manager</a></span></code></td><td><p></p><p>A new <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>.</p><p></p></td></tr></table></div><p>Once you have a reference to the <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>, you can start and stop it, register tasks and categories, and schedule task runs.</p><section class="s2"><h2>Since</h2><p>v1.0.0</p></section></section></article><aside></aside></main><footer><nav><a id="gh" href="https://github.com/tinyplex/tinytick" target="_blank">GitHub</a><a id="bs" href="https://bsky.app/profile/tinybase.bsky.social" target="_blank">Bluesky</a><a id="tw" href="https://x.com/tinybasejs" target="_blank">X / Twitter</a><a id="dc" href="https://discord.com/invite/mGz3mevwP8" target="_blank">Discord</a></nav><nav><a href="/">TinyTick <span id="version"></span></a> © 2025-</nav></footer></body><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ"></script><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-D1MGR8VRWJ');</script></html>
1+
<!DOCTYPE html><html lang="en"><head><link rel="dns-prefetch" href="https://www.googletagmanager.com/"><link href="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ" rel="preload" as="script"><link rel="preload" as="font" href="/fonts/inter.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/inconsolata.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/shantell.woff2" type="font/woff2" crossorigin="anonymous"><title>createManager | TinyTick</title><meta name="description" content="The createManager function creates a Manager, and is the main entry point into the tinytick module."><meta property="og:type" content="website"><meta property="og:title" content="createManager | TinyTick"><meta property="og:description" content="The createManager function creates a Manager, and is the main entry point into the tinytick module."><meta property="og:url" content="https://tinytick.org/api/tinytick/functions/creation/createmanager/"><meta property="og:image" content="https://tinytick.org/favicon_pad.png"><meta name="twitter:card" content="summary"><meta name="twitter:title" content="createManager | TinyTick"><meta name="twitter:description" content="The createManager function creates a Manager, and is the main entry point into the tinytick module."><meta name="twitter:site" content="@tinybasejs"><meta name="twitter:image" content="https://tinytick.org/favicon_pad.png"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" type="image/svg+xml" href="/favicon.svg"><link rel="stylesheet" href="/css/index.css"><link rel="canonical" href="https://tinytick.org/api/tinytick/functions/creation/createmanager/"><script src="/js/app.js"></script></head><body><header><a href="/"><img src="/favicon.svg" alt="TinyTick logo"><span>TinyTick</span></a><nav><ul><li><a href="/guides/">Guides</a></li><li><a href="/demos/">Demos</a></li><li><a href="/api/">API</a></li><li><a href="https://github.com/tinyplex/tinytick">GitHub</a></li></ul></nav><span id="dark"></span></header><main><nav><ul><li id="root" class="parent open"><span></span><a href="/">TinyTick</a><ul><li id="G" class="parent"><span></span><a href="/guides/">Guides</a></li><li id="D" class="parent"><span></span><a href="/demos/">Demos</a></li><li id="api" class="parent open"><span></span><a href="/api/">API</a><ul><li id="t" class="parent open"><span></span><a href="/api/tinytick/"><code>tinytick</code></a><ul><li id="t/I" class="parent"><span></span><a href="/api/tinytick/interfaces/">Interfaces</a></li><li id="t/F" class="parent open"><span></span><a href="/api/tinytick/functions/">Functions</a><ul><li id="cM" class="current"><span></span><a href="/api/tinytick/functions/creation/createmanager/"><code>createManager</code></a></li></ul></li><li id="t/TA" class="parent"><span></span><a href="/api/tinytick/type-aliases/">Type Aliases</a></li></ul></li></ul></li></ul></li></ul></nav><article><nav><ul><li><a href="/">TinyTick</a></li><li><a href="/api/">API</a></li><li><a href="/api/tinytick/"><code>tinytick</code></a></li><li><a href="/api/tinytick/functions/">Functions</a></li><li><a href="/api/tinytick/functions/creation/createmanager/"><code>createManager</code></a></li></ul></nav><section class="s1" id="/api/tinytick/functions/creation/createmanager/" data-id="cM"><h1><code>createManager</code></h1><p>The <code>createManager</code> function creates a <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>, and is the main entry point into the tinytick module.</p><pre><code><span class="function"><a href="/api/tinytick/functions/creation/createmanager/">createManager</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="/api/tinytick/interfaces/manager/manager/">Manager</a></span></code></pre><div class="table"><table><tr><th class="right">returns</th><td><code><span class="type"><a href="/api/tinytick/interfaces/manager/manager/">Manager</a></span></code></td><td><p></p><p>A new <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>.</p><p></p></td></tr></table></div><p>Once you have a reference to the <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a>, you can start and stop it, register tasks and categories, and schedule task runs.</p><section class="s2"><h2>Example</h2><p>This example creates a <a href="/api/tinytick/interfaces/manager/manager/"><code>Manager</code></a> object and gets its default configuration.</p><pre><code><span class="keyword">import</span> <span class="punctuation">{</span>createManager<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinytick'</span><span class="punctuation">;</span>
2+
3+
<span class="keyword">const</span> manager <span class="operator">=</span> <span class="function"><a href="/api/tinytick/functions/creation/createmanager/">createManager</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
4+
5+
console<span class="punctuation">.</span><span class="function">log</span><span class="punctuation">(</span>manager<span class="punctuation">.</span><span class="function"><a href="/api/tinytick/interfaces/manager/manager/methods/manager/getmanagerconfig/">getManagerConfig</a></span><span class="punctuation">(</span><span class="boolean">true</span><span class="punctuation">)</span><span class="punctuation">)</span><span class="punctuation">;</span>
6+
<span class="comment">// -> {tickInterval: 100}</span>
7+
</code></pre></section><section class="s2"><h2>Since</h2><p>v1.0.0</p></section></section></article><aside></aside></main><footer><nav><a id="gh" href="https://github.com/tinyplex/tinytick" target="_blank">GitHub</a><a id="bs" href="https://bsky.app/profile/tinybase.bsky.social" target="_blank">Bluesky</a><a id="tw" href="https://x.com/tinybasejs" target="_blank">X / Twitter</a><a id="dc" href="https://discord.com/invite/mGz3mevwP8" target="_blank">Discord</a></nav><nav><a href="/">TinyTick <span id="version"></span></a> © 2025-</nav></footer></body><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ"></script><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-D1MGR8VRWJ');</script></html>

0 commit comments

Comments
 (0)