Skip to content

Commit

Permalink
feat: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@iseizuu
iseizuu committed May 24, 2024
1 parent eddc28e commit 31ab57a
Show file tree
Hide file tree
Showing 15 changed files with 57 additions and 55 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ bin-release/
# should NOT be excluded as they contain compiler settings and other important
# information for Eclipse / Flash Builder.
node_modules
dist
8 changes: 4 additions & 4 deletions docs/classes/hoyo.default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/hoyo.ts:15</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/hoyo.ts#L15">src/hoyo.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="hoyo.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
Expand All @@ -130,7 +130,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> client</h3>
<div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="structure_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/hoyo.ts:15</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/hoyo.ts#L15">src/hoyo.ts:15</a></li>
</ul>
</aside>
</section>
Expand All @@ -147,7 +147,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> Hoyo<wbr>Tools</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/hoyo.ts:50</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/hoyo.ts#L50">src/hoyo.ts:50</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -170,7 +170,7 @@ <h3>get<wbr>Hoyo<wbr>Art</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/hoyo.ts:25</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/hoyo.ts#L25">src/hoyo.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/structure_client.default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/structure/client.ts:4</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/structure/client.ts#L4">src/structure/client.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="structure_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
Expand All @@ -123,7 +123,7 @@ <h3>get</h3>
<div class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">:</span> <a href="utils_request.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/structure/client.ts:4</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/structure/client.ts#L4">src/structure/client.ts:4</a></li>
</ul>
</aside>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/utils_request.default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/utils/request.ts:4</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/utils/request.ts#L4">src/utils/request.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="utils_request.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
Expand All @@ -128,7 +128,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr>Request</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/utils/request.ts:8</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/utils/request.ts#L8">src/utils/request.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -154,7 +154,7 @@ <h3>request</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/utils/request.ts:14</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/utils/request.ts#L14">src/utils/request.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
20 changes: 10 additions & 10 deletions docs/classes/wallpaper.animewallpaper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:10</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L10">src/wallpaper.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="wallpaper.animewallpaper.html" class="tsd-signature-type" data-tsd-kind="Class">AnimeWallpaper</a></h4>
Expand All @@ -136,7 +136,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> client</h3>
<div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="structure_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:9</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L9">src/wallpaper.ts:9</a></li>
</ul>
</aside>
</section>
Expand All @@ -146,7 +146,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> hoyo</h3>
<div class="tsd-signature tsd-kind-icon">hoyo<span class="tsd-signature-symbol">:</span> <a href="hoyo.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:10</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L10">src/wallpaper.ts:10</a></li>
</ul>
</aside>
</section>
Expand All @@ -163,7 +163,7 @@ <h3>Hoyolab</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:53</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L53">src/wallpaper.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -197,7 +197,7 @@ <h3>random</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:43</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L43">src/wallpaper.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -220,7 +220,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> scrape<wbr>From<wbr>Wal
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:117</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L117">src/wallpaper.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -248,7 +248,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> scrape<wbr>From<wbr>Wal
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:86</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L86">src/wallpaper.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -276,7 +276,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> scrape<wbr>From<wbr>Zer
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:150</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L150">src/wallpaper.ts:150</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -304,7 +304,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> scrape<wbr>Random<wbr>W
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:62</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L62">src/wallpaper.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -327,7 +327,7 @@ <h3>search</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in src/wallpaper.ts:25</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/wallpaper.ts#L25">src/wallpaper.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/enums/typings_enum.animesource.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h3>Wall<wbr>Haven</h3>
<div class="tsd-signature tsd-kind-icon">Wall<wbr>Haven<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:2</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L2">src/typings/enum.ts:2</a></li>
</ul>
</aside>
</section>
Expand All @@ -101,7 +101,7 @@ <h3>Wallpapers</h3>
<div class="tsd-signature tsd-kind-icon">Wallpapers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 4</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:4</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L4">src/typings/enum.ts:4</a></li>
</ul>
</aside>
</section>
Expand All @@ -111,7 +111,7 @@ <h3>Zero<wbr>Chan</h3>
<div class="tsd-signature tsd-kind-icon">Zero<wbr>Chan<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 3</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:3</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L3">src/typings/enum.ts:3</a></li>
</ul>
</aside>
</section>
Expand Down
10 changes: 5 additions & 5 deletions docs/enums/typings_enum.hoyoapp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <h3>Genshin<wbr>Impact</h3>
<div class="tsd-signature tsd-kind-icon">Genshin<wbr>Impact<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:9</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L9">src/typings/enum.ts:9</a></li>
</ul>
</aside>
</section>
Expand All @@ -103,7 +103,7 @@ <h3>Honkai<wbr>Impact</h3>
<div class="tsd-signature tsd-kind-icon">Honkai<wbr>Impact<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:10</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L10">src/typings/enum.ts:10</a></li>
</ul>
</aside>
</section>
Expand All @@ -113,7 +113,7 @@ <h3>Honkai<wbr>Star<wbr>Rail</h3>
<div class="tsd-signature tsd-kind-icon">Honkai<wbr>Star<wbr>Rail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 6</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:11</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L11">src/typings/enum.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -123,7 +123,7 @@ <h3>Tear<wbr>OfThemis</h3>
<div class="tsd-signature tsd-kind-icon">Tear<wbr>OfThemis<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 4</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:12</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L12">src/typings/enum.ts:12</a></li>
</ul>
</aside>
</section>
Expand All @@ -133,7 +133,7 @@ <h3>Zenless<wbr>Zone<wbr>Zero</h3>
<div class="tsd-signature tsd-kind-icon">Zenless<wbr>Zone<wbr>Zero<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:8</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L8">src/typings/enum.ts:8</a></li>
</ul>
</aside>
</section>
Expand Down
8 changes: 4 additions & 4 deletions docs/enums/typings_enum.hoyooptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3>Featured</h3>
<div class="tsd-signature tsd-kind-icon">Featured<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/elite&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:17</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L17">src/typings/enum.ts:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -102,7 +102,7 @@ <h3>New<wbr>Post</h3>
<div class="tsd-signature tsd-kind-icon">New<wbr>Post<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/new&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:18</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L18">src/typings/enum.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -112,7 +112,7 @@ <h3>New<wbr>Reply</h3>
<div class="tsd-signature tsd-kind-icon">New<wbr>Reply<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/reply&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:19</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L19">src/typings/enum.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -122,7 +122,7 @@ <h3>Trending</h3>
<div class="tsd-signature tsd-kind-icon">Trending<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/typings/enum.ts:16</li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/enum.ts#L16">src/typings/enum.ts:16</a></li>
</ul>
</aside>
</section>
Expand Down
23 changes: 12 additions & 11 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,17 +134,18 @@ <h1>Hoyolab Example</h1>
<a href="#result" id="result" style="color: inherit; text-decoration: none;">
<h4>Result</h4>
</a>
<pre><code class="language-json"><span style="color: #000000">data: {</span>
<span style="color: #000000"> </span><span style="color: #CD3131">list</span><span style="color: #000000">: [</span>
<span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #CD3131">game</span><span style="color: #000000">: {</span><span style="color: #CD3131">...</span><span style="color: #000000">},</span>
<span style="color: #000000"> </span><span style="color: #CD3131">post</span><span style="color: #000000">: {</span><span style="color: #CD3131">...</span><span style="color: #000000">},</span>
<span style="color: #000000"> </span><span style="color: #CD3131">topics</span><span style="color: #000000">: [{</span><span style="color: #CD3131">...</span><span style="color: #000000">}]</span>
<span style="color: #000000"> </span><span style="color: #CD3131">user:</span><span style="color: #000000"> {</span><span style="color: #CD3131">...</span><span style="color: #000000">}</span>
<span style="color: #000000"> }</span>
<span style="color: #000000"> ]</span>
<span style="color: #000000">}</span>

<pre><code class="language-txt">{
data: {
list: [
{
game: {...},
post: {...},
topics: [{...}]
user: {...}
}
]
}
}
</code></pre>
<a href="#warning" id="warning" style="color: inherit; text-decoration: none;">
<h2>Warning</h2>
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/typings.dataimageformat.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> image</h3>
<div class="tsd-signature tsd-kind-icon">image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/02f9ebb/src/typings/index.ts#L7">src/typings/index.ts:7</a></li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/index.ts#L7">src/typings/index.ts:7</a></li>
</ul>
</aside>
</section>
Expand All @@ -109,7 +109,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> thumbnail</h3>
<div class="tsd-signature tsd-kind-icon">thumbnail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/02f9ebb/src/typings/index.ts#L6">src/typings/index.ts:6</a></li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/index.ts#L6">src/typings/index.ts:6</a></li>
</ul>
</aside>
</section>
Expand All @@ -119,7 +119,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/02f9ebb/src/typings/index.ts#L5">src/typings/index.ts:5</a></li>
<li>Defined in <a href="https://github.com/iseizuu/anime-wallpaper/blob/eddc28e/src/typings/index.ts#L5">src/typings/index.ts:5</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 31ab57a

Please sign in to comment.