CI updated the documentation
This commit is contained in:
1
docs/.nojekyll
Normal file
1
docs/.nojekyll
Normal file
@@ -0,0 +1 @@
|
|||||||
|
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
||||||
1
docs/.typedoc-plugin-versions
Normal file
1
docs/.typedoc-plugin-versions
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"versions":["v0.0.1"],"dev":"v0.0.1"}
|
||||||
1
docs/index.html
Normal file
1
docs/index.html
Normal file
@@ -0,0 +1 @@
|
|||||||
|
<meta http-equiv="refresh" content="0; url=dev/"/>
|
||||||
1
docs/stable
Symbolic link
1
docs/stable
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
/home/runner/work/pushover/pushover/docs/v0.0.1
|
||||||
1
docs/v0.0.1/assets/hierarchy.js
Normal file
1
docs/v0.0.1/assets/hierarchy.js
Normal file
@@ -0,0 +1 @@
|
|||||||
|
window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzytWsqqurQUAmx4Kpg=="
|
||||||
43
docs/v0.0.1/assets/highlight.css
Normal file
43
docs/v0.0.1/assets/highlight.css
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
:root {
|
||||||
|
--light-hl-0: #795E26;
|
||||||
|
--dark-hl-0: #DCDCAA;
|
||||||
|
--light-hl-1: #000000;
|
||||||
|
--dark-hl-1: #D4D4D4;
|
||||||
|
--light-hl-2: #A31515;
|
||||||
|
--dark-hl-2: #CE9178;
|
||||||
|
--light-code-background: #FFFFFF;
|
||||||
|
--dark-code-background: #1E1E1E;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-color-scheme: light) { :root {
|
||||||
|
--hl-0: var(--light-hl-0);
|
||||||
|
--hl-1: var(--light-hl-1);
|
||||||
|
--hl-2: var(--light-hl-2);
|
||||||
|
--code-background: var(--light-code-background);
|
||||||
|
} }
|
||||||
|
|
||||||
|
@media (prefers-color-scheme: dark) { :root {
|
||||||
|
--hl-0: var(--dark-hl-0);
|
||||||
|
--hl-1: var(--dark-hl-1);
|
||||||
|
--hl-2: var(--dark-hl-2);
|
||||||
|
--code-background: var(--dark-code-background);
|
||||||
|
} }
|
||||||
|
|
||||||
|
:root[data-theme='light'] {
|
||||||
|
--hl-0: var(--light-hl-0);
|
||||||
|
--hl-1: var(--light-hl-1);
|
||||||
|
--hl-2: var(--light-hl-2);
|
||||||
|
--code-background: var(--light-code-background);
|
||||||
|
}
|
||||||
|
|
||||||
|
:root[data-theme='dark'] {
|
||||||
|
--hl-0: var(--dark-hl-0);
|
||||||
|
--hl-1: var(--dark-hl-1);
|
||||||
|
--hl-2: var(--dark-hl-2);
|
||||||
|
--code-background: var(--dark-code-background);
|
||||||
|
}
|
||||||
|
|
||||||
|
.hl-0 { color: var(--hl-0); }
|
||||||
|
.hl-1 { color: var(--hl-1); }
|
||||||
|
.hl-2 { color: var(--hl-2); }
|
||||||
|
pre, code { background: var(--code-background); }
|
||||||
18
docs/v0.0.1/assets/icons.js
Normal file
18
docs/v0.0.1/assets/icons.js
Normal file
File diff suppressed because one or more lines are too long
1
docs/v0.0.1/assets/icons.svg
Normal file
1
docs/v0.0.1/assets/icons.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 12 KiB |
60
docs/v0.0.1/assets/main.js
Normal file
60
docs/v0.0.1/assets/main.js
Normal file
File diff suppressed because one or more lines are too long
1
docs/v0.0.1/assets/navigation.js
Normal file
1
docs/v0.0.1/assets/navigation.js
Normal file
@@ -0,0 +1 @@
|
|||||||
|
window.navigationData = "eJyLrlYqSa0oUbJSCigtzsgvSy1S0lEqSCzJULJSKqksSC3Wh4nrZZTk5ijpKGVn5qUoWRkZWJobmhrV6mDo900tLk5MT8VlDFSakGmhxZguAYlh1xcLADETQZo="
|
||||||
1
docs/v0.0.1/assets/search.js
Normal file
1
docs/v0.0.1/assets/search.js
Normal file
@@ -0,0 +1 @@
|
|||||||
|
window.searchData = "eJytmFuP2zYQhf/L9JVwPOOr9NaiD+1DgQBJ+iIYC8did4X4IkjypoHh/15Qls2hOLbHqZ92YfGcw8tHjsQDVLvvNaTZAb4V2xxSGiYznJCB7XJjIYWP+/pt926rv2xdL18tGNhXa0ih+VHa+kPv6eCt2azBwGq9rGtbQwpwNGdnHNL4YrtR2/3y8uIeegEzN1AuK7tt4n4OTqpr8U3RrB8IPzd/RrSLVAefGj8jtqyKXVU0P/TZTPGMDtS7/TbXp5+bP2e1N7ZulpvykRX3kmd0odsYyvR4G/108LJplqu3jZOq4wPNU5ivbVU/QH3X/CnjL8vPu292+8Doy7LpFD/ZgWtn6JU+6E/NV9t8cvvi2lzyYbzapj63vT2OOzP4apvf7XuxssrU/NL4f8XW9upxEZwTVnFM3In6XjRvt+sbT3SttdVIEfz5Rinqx+rqkCL0y9Ui1I/UVCBF4Mfb5aefqq49iuhPNwpPP1dXdVSrervkxCurrTeK8D+uF5t+rqrSKCJ/vVdm+sEP1BhF/G/L2k7HD3fiayt7XleWef7lRqkLqkye68rc/fLiInuJ7id9WWn/XDHouts1kbvaNr7zCibU4H7G7aqrCMnFMtWPuVefgqCFgWKb238hPcC7repit4UUaDAaJGDgn8Kuc/f1dJ7C1W7TcZTvVvv230XX7G+7anaVa3xq/WEIJhsaSgbJZLZYmOwsbh+0P5w9/C+tEMFkKAkxEmIgJDAZSUKKhBQIR2CykSQcRcJRIByDycaScBwJx4FwAiabSMJJJJwEwimYbCoJp5FwGghnYLKZJJxFwlkgnIPJ5pJwHgnngTABkyWSMImESQiA4wFFdjCGB3v0tPjI/AgAhQSh4wJFhjCGCEOK0LGBIkcYg4QhSej4QJEljGHCkCZ0jKDIE8ZAYUgUOk5QZApjqDCkCh0rKHKFMVgYkoWOFxTZwhguDOlCxwyKfGEMGIaEkWOGRMIoJoxCwsgxQyJhFBNGvTOqPaTkU0o4pkLCyDFDImEUE0YhYeSYIZEwigmjkDByzJBIGMWEUUgYOWZIJIxiwigkjBwzJBJGMWEUEkaOGRIJo5iw7qe2Jr7bqrH5n6famGXg32cO8NKVTF+aD0BjSA/Hoy+R6eHIqqR75rL8x7e3waG3waHOhr3SeaO595mrbC6vCmxMzIR0LvybmI1qxEY10hqdP+mZDzEfUvmcXgy9xcw7zFQGl89f1g3WC5XH6Y2JTeyUTexUZeG/Er0NQ05HXHm5nGGD4aPRDedsI0wNw1dH7+lOg3WHDQp1o+o+ZL3HxFtMVA7si9S7sDXSLVF3Y8GWma2yzqF/HBDDlXS8tpcY3oHtPN3G29chH8Rmk3TTGR2OibdIVA79r2bWHT6pulmVv36ZJZsj0k2Sv05gNmwjkW4jBddrbA+wKUfdlIcXScyKHeGoO8LZ3RDzYUuI+jUUNxaxQ4J0pwS7EGR9YjsUdVv0csvHXNgWQ8UWWxgoi9Kui62FNFscj/8BeVZMUA==";
|
||||||
1611
docs/v0.0.1/assets/style.css
Normal file
1611
docs/v0.0.1/assets/style.css
Normal file
File diff suppressed because it is too large
Load Diff
21
docs/v0.0.1/assets/versionsMenu.js
Normal file
21
docs/v0.0.1/assets/versionsMenu.js
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
import { DOC_VERSIONS } from '../../versions.js';
|
||||||
|
|
||||||
|
const select = document.getElementById('plugin-versions-select');
|
||||||
|
|
||||||
|
DOC_VERSIONS.forEach((version) => {
|
||||||
|
const option = document.createElement('option');
|
||||||
|
option.value = version;
|
||||||
|
option.innerHTML = version;
|
||||||
|
select.appendChild(option);
|
||||||
|
});
|
||||||
|
|
||||||
|
const locationSplit = location.pathname.split('/');
|
||||||
|
const thisVersion = locationSplit.find((path) => ['stable', 'dev', ...DOC_VERSIONS].includes(path));
|
||||||
|
select.value = DOC_VERSIONS.includes(thisVersion)
|
||||||
|
? thisVersion
|
||||||
|
: DOC_VERSIONS[0];
|
||||||
|
select.onchange = () => {
|
||||||
|
const newPaths = window.location.pathname.replace(`/${thisVersion}/`, `/${select.value}/`);
|
||||||
|
const newUrl = new URL(newPaths, window.location.origin);
|
||||||
|
window.location.assign(newUrl);
|
||||||
|
};
|
||||||
1
docs/v0.0.1/coverage.json
Normal file
1
docs/v0.0.1/coverage.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"percent":19,"expected":42,"actual":8,"notDocumented":["PushoverMessage","PushoverMessage.__type.priority","PushoverMessage.__type.priority.__type.level","PushoverMessage.__type.priority.__type.retry","PushoverMessage.__type.priority.__type.expire","PushoverMessage.__type.priority.__type.callback","PushoverMessage.__type.sound","PushoverMessage.__type.timestamp","PushoverMessage.__type.html","PushoverMessage.__type.attachment","PushoverMessage.__type.attachment.__type.type","PushoverMessage.__type.attachment.__type.data","PushoverMessage.__type.users","PushoverMessage.__type.users.__type.name","PushoverMessage.__type.users.__type.token","PushoverMessage.__type.users.__type.devices","PushoverMessage.__type.appToken","Pushover","Pushover.__type.getSounds.__type.__type.__type.sounds","Pushover.__type.getDevices.__type.__type.__type.devices","Pushover.__type.withMessage","Pushover.__type.withTitle","Pushover.__type.withUrl","Pushover.__type.withPriority","Pushover.__type.withSound","Pushover.__type.withTimestamp","Pushover.__type.withHtml","Pushover.__type.withAttachment","Pushover.__type.withBase64Attachment","Pushover.__type.addUsers","User","User.__type.name","User.__type.token","User.__type.devices"]}
|
||||||
21
docs/v0.0.1/coverage.svg
Normal file
21
docs/v0.0.1/coverage.svg
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="130" height="20">
|
||||||
|
<script/>
|
||||||
|
<linearGradient id="a" x2="0" y2="100%">
|
||||||
|
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||||
|
<stop offset="1" stop-opacity=".1"/>
|
||||||
|
</linearGradient>
|
||||||
|
<rect rx="3" width="130" height="20" fill="#555"/>
|
||||||
|
<rect rx="3" x="90" width="40" height="20" fill="#db654f"/>
|
||||||
|
<path fill="#db654f" d="M90 0h4v20h-4z"/>
|
||||||
|
<rect rx="3" width="130" height="20" fill="url(#a)"/>
|
||||||
|
<g fill="#fff" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
|
||||||
|
<g text-anchor="left">
|
||||||
|
<text x="5" y="15" fill="#010101" fill-opacity=".3">Docs Coverage</text>
|
||||||
|
<text x="5" y="14">Docs Coverage</text>
|
||||||
|
</g>
|
||||||
|
<g text-anchor="middle">
|
||||||
|
<text x="110" y="15" fill="#010101" fill-opacity=".3">19%</text>
|
||||||
|
<text x="110" y="14">19%</text>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 861 B |
57
docs/v0.0.1/index.html
Normal file
57
docs/v0.0.1/index.html
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@cis-oss/pushover</title><meta name="description" content="Documentation for @cis-oss/pushover"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><style>
|
||||||
|
.tsd-ext-version-select .settings-label {
|
||||||
|
margin: 0.75rem 0.75rem 0 0;
|
||||||
|
</style></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@cis-oss/pushover</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@cis-oss/pushover</h1></div><div class="tsd-panel tsd-typography"><a id="cis-pushover-client" class="tsd-anchor"></a><h1 class="tsd-anchor-link">CIS Pushover Client<a href="#cis-pushover-client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>A client for Pushover, a service for sending notifications. Typesafe.
|
||||||
|
Supports sending the same message to multiple users.</p>
|
||||||
|
<a id="installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>⚠️ This package is <strong>not yet published</strong> to npm.</p>
|
||||||
|
<pre><code class="bash"><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">@cis-oss/pushover</span>
|
||||||
|
</code><button type="button">Copy</button></pre>
|
||||||
|
|
||||||
|
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@cis-oss/pushover</span>
|
||||||
|
</code><button type="button">Copy</button></pre>
|
||||||
|
|
||||||
|
<pre><code class="bash"><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">@cis-oss/pushover</span>
|
||||||
|
</code><button type="button">Copy</button></pre>
|
||||||
|
|
||||||
|
<pre><code class="bash"><span class="hl-0">bun</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">@cis-oss/pushover</span>
|
||||||
|
</code><button type="button">Copy</button></pre>
|
||||||
|
|
||||||
|
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-ext-version-select"><label class="settings-label" for="plugin-versions-select">Version</label><select id="plugin-versions-select" name="versions"></select></div><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#cis-pushover-client"><span>CIS <wbr/>Pushover <wbr/>Client</span></a><ul><li><a href="#installation"><span>Installation</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@cis-oss/pushover</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> v0.27.9<br>
|
||||||
|
<span id="generation-date"></span>
|
||||||
|
<script>
|
||||||
|
window.GENERATION_DATE = 1741642047113;
|
||||||
|
|
||||||
|
(() => {
|
||||||
|
|
||||||
|
const formatter = new Intl.RelativeTimeFormat('en', {
|
||||||
|
numeric: 'auto',
|
||||||
|
style: 'short',
|
||||||
|
});
|
||||||
|
|
||||||
|
const divisions = [
|
||||||
|
{ amount: 60, name: 'seconds' },
|
||||||
|
{ amount: 60, name: 'minutes' },
|
||||||
|
{ amount: 24, name: 'hours' },
|
||||||
|
{ amount: 7, name: 'days' },
|
||||||
|
{ amount: 4.34524, name: 'weeks' },
|
||||||
|
{ amount: 12, name: 'months' },
|
||||||
|
{ amount: Number.POSITIVE_INFINITY, name: 'years' }
|
||||||
|
];
|
||||||
|
|
||||||
|
function formatTimeAgo(date) {
|
||||||
|
let duration = (date - new Date()) / 1000;
|
||||||
|
|
||||||
|
for (const division of divisions) {
|
||||||
|
if (Math.abs(duration) < division.amount) {
|
||||||
|
return formatter.format(Math.round(duration), division.name);
|
||||||
|
}
|
||||||
|
duration /= division.amount;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
document.getElementById('generation-date').title = new Date(window.GENERATION_DATE).toLocaleString();
|
||||||
|
document.getElementById('generation-date').innerText = `Last modified ${formatTimeAgo(window.GENERATION_DATE)}`;
|
||||||
|
|
||||||
|
})();
|
||||||
|
</script>
|
||||||
|
</p></footer><div class="overlay"></div><script src="assets/versionsMenu.js" type="module"></script></body></html>
|
||||||
42
docs/v0.0.1/modules.html
Normal file
42
docs/v0.0.1/modules.html
Normal file
File diff suppressed because one or more lines are too long
45
docs/v0.0.1/types/Pushover.html
Normal file
45
docs/v0.0.1/types/Pushover.html
Normal file
File diff suppressed because one or more lines are too long
47
docs/v0.0.1/types/PushoverMessage.html
Normal file
47
docs/v0.0.1/types/PushoverMessage.html
Normal file
File diff suppressed because one or more lines are too long
42
docs/v0.0.1/types/User.html
Normal file
42
docs/v0.0.1/types/User.html
Normal file
File diff suppressed because one or more lines are too long
5
docs/versions.js
Normal file
5
docs/versions.js
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
"use strict"
|
||||||
|
export const DOC_VERSIONS = [
|
||||||
|
'dev',
|
||||||
|
'v0.0',
|
||||||
|
];
|
||||||
Reference in New Issue
Block a user