Skip to content

Commit a4b23a9

Browse files
author
teodorus-nathaniel
committed
Add typedoc for utils package
1 parent ddb0cbe commit a4b23a9

File tree

71 files changed

+7595
-481
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+7595
-481
lines changed

docs/assets/custom.css

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.container-main {
2+
display: flex;
3+
flex-direction: row-reverse;
4+
}
5+
6+
.col-menu {
7+
border-left: transparent;
8+
border-right: 1px solid var(--color-accent);
9+
}
10+
11+
div.col-8.col-content {
12+
padding-left: 16px;
13+
}
14+
15+
div.col-4.col-menu.menu-sticky-wrap.menu-highlight {
16+
/* apply css rules on content columns to menubar */
17+
padding: 2rem 1rem 2rem 0;
18+
margin: 2rem auto;
19+
}
20+
21+
div.tsd-page-title > h2 {
22+
/* aligns horizontally title h2 with left menubar */
23+
margin: -0.2rem 0;
24+
font-size: 1.875rem;
25+
}

docs/assets/highlight.css

-7
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,22 @@
11
:root {
2-
--light-hl-0: #000000;
3-
--dark-hl-0: #D4D4D4;
42
--light-code-background: #FFFFFF;
53
--dark-code-background: #1E1E1E;
64
}
75

86
@media (prefers-color-scheme: light) { :root {
9-
--hl-0: var(--light-hl-0);
107
--code-background: var(--light-code-background);
118
} }
129

1310
@media (prefers-color-scheme: dark) { :root {
14-
--hl-0: var(--dark-hl-0);
1511
--code-background: var(--dark-code-background);
1612
} }
1713

1814
:root[data-theme='light'] {
19-
--hl-0: var(--light-hl-0);
2015
--code-background: var(--light-code-background);
2116
}
2217

2318
:root[data-theme='dark'] {
24-
--hl-0: var(--dark-hl-0);
2519
--code-background: var(--dark-code-background);
2620
}
2721

28-
.hl-0 { color: var(--hl-0); }
2922
pre, code { background: var(--code-background); }

docs/assets/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/subsocial.SubsocialApi.html renamed to docs/classes/api_src_subsocial.SubsocialApi.html

+242-183
Large diffs are not rendered by default.

docs/classes/substrate.SubsocialSubstrateApi.html renamed to docs/classes/api_src_substrate.SubsocialSubstrateApi.html

+179-176
Large diffs are not rendered by default.

docs/functions/utils_src.asString.html

+124
Large diffs are not rendered by default.

docs/functions/utils_src.asStringArray.html

+115
Large diffs are not rendered by default.

docs/functions/utils_src.balanceWithDecimal.html

+119
Large diffs are not rendered by default.

docs/functions/utils_src.bnToId.html

+115
Large diffs are not rendered by default.

docs/functions/utils_src.bnsToIds.html

+115
Large diffs are not rendered by default.

docs/functions/utils_src.buildMdToEntity.html

+126
Large diffs are not rendered by default.

docs/functions/utils_src.convertToBalanceWithDecimal.html

+119
Large diffs are not rendered by default.

docs/functions/utils_src.createPostSlug.html

+119
Large diffs are not rendered by default.

docs/functions/utils_src.createTwitterURL.html

+122
Large diffs are not rendered by default.

docs/functions/utils_src.extractVideoId.html

+117
Large diffs are not rendered by default.

docs/functions/utils_src.formatBalanceWithoutDecimals.html

+117
Large diffs are not rendered by default.

docs/functions/utils_src.getEmbedUrl.html

+119
Large diffs are not rendered by default.

docs/functions/utils_src.getFirstOrDefault.html

+122
Large diffs are not rendered by default.

docs/functions/utils_src.getFirstOrUndefined.html

+120
Large diffs are not rendered by default.

docs/functions/utils_src.getLinkBrand.html

+117
Large diffs are not rendered by default.

docs/functions/utils_src.getPostIdFromSlug.html

+117
Large diffs are not rendered by default.

docs/functions/utils_src.idToBn.html

+115
Large diffs are not rendered by default.

docs/functions/utils_src.idsToBns.html

+115
Large diffs are not rendered by default.

docs/functions/utils_src.isDef.html

+120
Large diffs are not rendered by default.

docs/functions/utils_src.isDefined.html

+120
Large diffs are not rendered by default.

docs/functions/utils_src.isEmptyArray.html

+120
Large diffs are not rendered by default.

docs/functions/utils_src.isEmptyObj.html

+120
Large diffs are not rendered by default.

docs/functions/utils_src.isEmptyStr.html

+115
Large diffs are not rendered by default.

docs/functions/utils_src.isNum.html

+115
Large diffs are not rendered by default.

docs/functions/utils_src.isObj.html

+120
Large diffs are not rendered by default.

docs/functions/utils_src.isSocialBrandLink.html

+119
Large diffs are not rendered by default.

docs/functions/utils_src.isStr.html

+115
Large diffs are not rendered by default.

docs/functions/utils_src.mdToHtml.html

+117
Large diffs are not rendered by default.

docs/functions/utils_src.mdToText.html

+117
Large diffs are not rendered by default.

docs/functions/utils_src.newLogger-1.html

+117
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setDefaultLevel | Subsocial JS SDK</title><meta name="description" content="Documentation for Subsocial JS SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2+
<div class="tsd-toolbar-contents container">
3+
<div class="table-cell" id="tsd-search" data-base="..">
4+
<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"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5+
<div class="field">
6+
<div id="tsd-toolbar-links"></div></div>
7+
<ul class="results">
8+
<li class="state loading">Preparing search index...</li>
9+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Subsocial JS SDK</a></div>
10+
<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"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11+
<div class="container container-main">
12+
<div class="col-8 col-content">
13+
<div class="tsd-page-title">
14+
<ul class="tsd-breadcrumb">
15+
<li><a href="../modules.html">Subsocial JS SDK</a></li>
16+
<li><a href="../modules/utils_src.html">utils/src</a></li>
17+
<li><a href="../modules/utils_src.newLogger.html">newLogger</a></li>
18+
<li><a href="utils_src.newLogger.setDefaultLevel.html">setDefaultLevel</a></li></ul>
19+
<h1>Function setDefaultLevel</h1></div>
20+
<section class="tsd-panel">
21+
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
22+
<li class="tsd-signature tsd-anchor-link" id="setDefaultLevel">set<wbr/>Default<wbr/>Level<span class="tsd-signature-symbol">(</span>logLevel<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">LogLevel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setDefaultLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></li>
23+
<li class="tsd-description">
24+
<div class="tsd-parameters">
25+
<h4 class="tsd-parameters-title">Parameters</h4>
26+
<ul class="tsd-parameter-list">
27+
<li>
28+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> logLevel: <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">LogLevel</span></h5></li></ul></div>
29+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
30+
<ul>
31+
<li>Defined in <a href="https://github.com/dappforce/subsocial-js/blob/ddb0cbe/packages/utils/src/logger.ts#L49">utils/src/logger.ts:49</a></li></ul></aside></li></ul></section></div>
32+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
33+
<div class="tsd-navigation settings">
34+
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
35+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
36+
<div class="tsd-accordion-details">
37+
<div class="tsd-filter-visibility">
38+
<h4 class="uppercase">Member Visibility</h4><form>
39+
<ul id="tsd-filter-options">
40+
<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>
41+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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>Private</span></label></li>
42+
<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></ul></form></div>
43+
<div class="tsd-theme-toggle">
44+
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
45+
<nav class="tsd-navigation primary">
46+
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
47+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
48+
<div class="tsd-accordion-details">
49+
<ul>
50+
<li class="current"><a href="../modules.html">Subsocial JS SDK</a>
51+
<ul>
52+
<li class="tsd-kind-module"><a href="../modules/api_src_subsocial.html">api/src/subsocial</a></li>
53+
<li class="tsd-kind-module"><a href="../modules/api_src_substrate.html">api/src/substrate</a></li>
54+
<li class="current tsd-kind-module"><a href="../modules/utils_src.html">utils/src</a>
55+
<ul>
56+
<li class="current tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/utils_src.newLogger.html">new<wbr/>Logger</a></li></ul></li></ul></li></ul></div></details></nav>
57+
<nav class="tsd-navigation secondary menu-sticky">
58+
<ul>
59+
<li class="current tsd-kind-function tsd-parent-kind-namespace"><a href="utils_src.newLogger.setDefaultLevel.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>set<wbr/>Default<wbr/>Level</a></li></ul></nav></div></div>
60+
<div class="overlay"></div><script src="../assets/main.js"></script></body></html>

0 commit comments

Comments
 (0)