Skip to content
This repository was archived by the owner on Dec 27, 2024. It is now read-only.

Commit 41fcf82

Browse files
etsuoetsuo
committed
updates
1 parent ff167c7 commit 41fcf82

File tree

208 files changed

+13940
-33555
lines changed

Some content is hidden

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

208 files changed

+13940
-33555
lines changed

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# SakuraApi Core API Documentation
22

3-
## SakuraApi Manual
3+
This project is mostly auto-generated from TypeDoc embedded in the `core` project code located [here](https://github.com/sakuraapi/core).
4+
5+
## Core API Documentation
46

5-
You can find the Sakura Api Manual [here](https://github.com/sakuraapi/manual).
7+
https://sakuraapi.github.io/docs-core/
68

7-
## API Documentation
9+
## SakuraApi Manual
810

9-
- [Develop Branch Documentation](./develop/index.html)
10-
- [Master Branch Documentation](./master/index.html)
11+
https://github.com/sakuraapi/manual
1112

1213
## Reporting issues with the docs
1314

1415
If you find an issue with the develop or master branch API documentation, please open
1516
a ticket or tack and pull request [here](https://github.com/sakuraapi/core/issues).
1617

17-
Published: {{ site.time }}

‎develop/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎develop/classes/_core__injectable_injectable_.noninjectableconstructorparametererror.html‎

Lines changed: 0 additions & 316 deletions
This file was deleted.

‎develop/classes/_core__injectable_injectable_.providersmustbedecoratedwithinjectableerror.html‎

Lines changed: 0 additions & 312 deletions
This file was deleted.

‎develop/classes/_core__routable_routable_.routablenotregistered.html‎

Lines changed: 0 additions & 323 deletions
This file was deleted.

‎develop/classes/_core__routable_routable_.routablesmustbedecoratedwithroutableerror.html‎

Lines changed: 0 additions & 321 deletions
This file was deleted.

‎develop/classes/_core_plugins_.authenticatornotregistered.html‎

Lines changed: 0 additions & 326 deletions
This file was deleted.

‎develop/classes/_core_plugins_.authenticatorsmustbedecoratedwithauthenticatorpluginerror.html‎

Lines changed: 0 additions & 324 deletions
This file was deleted.

‎master/classes/_core_plugins_.anonymous.html‎ renamed to ‎develop/classes/anonymous.html‎

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,7 @@
5454
<a href="../globals.html">Globals</a>
5555
</li>
5656
<li>
57-
<a href="../modules/_core_plugins_.html">&quot;core/plugins&quot;</a>
58-
</li>
59-
<li>
60-
<a href="_core_plugins_.anonymous.html">Anonymous</a>
57+
<a href="anonymous.html">Anonymous</a>
6158
</li>
6259
</ul>
6360
<h1>Class Anonymous</h1>
@@ -87,8 +84,8 @@ <h3>Hierarchy</h3>
8784
<section class="tsd-panel">
8885
<h3>Implements</h3>
8986
<ul class="tsd-hierarchy">
90-
<li><a href="../interfaces/_core_plugins_.iauthenticator.html" class="tsd-signature-type">IAuthenticator</a></li>
91-
<li><a href="../interfaces/_core_plugins_.iauthenticatorconstructor.html" class="tsd-signature-type">IAuthenticatorConstructor</a></li>
87+
<li><a href="../interfaces/iauthenticator.html" class="tsd-signature-type">IAuthenticator</a></li>
88+
<li><a href="../interfaces/iauthenticatorconstructor.html" class="tsd-signature-type">IAuthenticatorConstructor</a></li>
9289
</ul>
9390
</section>
9491
<section class="tsd-panel-group tsd-index-group">
@@ -98,7 +95,7 @@ <h2>Index</h2>
9895
<section class="tsd-index-section ">
9996
<h3>Methods</h3>
10097
<ul class="tsd-index-list">
101-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_plugins_.anonymous.html#authenticate" class="tsd-kind-icon">authenticate</a></li>
98+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="anonymous.html#authenticate" class="tsd-kind-icon">authenticate</a></li>
10299
</ul>
103100
</section>
104101
</div>
@@ -110,7 +107,7 @@ <h2>Methods</h2>
110107
<a name="authenticate" class="tsd-anchor"></a>
111108
<h3>authenticate</h3>
112109
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
113-
<li class="tsd-signature tsd-kind-icon">authenticate<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Request</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_core_plugins_.authenticatorpluginresult.html" class="tsd-signature-type">AuthenticatorPluginResult</a><span class="tsd-signature-symbol">&gt;</span></li>
110+
<li class="tsd-signature tsd-kind-icon">authenticate<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Request</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/authenticatorpluginresult.html" class="tsd-signature-type">AuthenticatorPluginResult</a><span class="tsd-signature-symbol">&gt;</span></li>
114111
</ul>
115112
<ul class="tsd-descriptions">
116113
<li class="tsd-description">
@@ -134,7 +131,7 @@ <h5>req: <span class="tsd-signature-type">Request</span></h5>
134131
<h5>res: <span class="tsd-signature-type">Response</span></h5>
135132
</li>
136133
</ul>
137-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_core_plugins_.authenticatorpluginresult.html" class="tsd-signature-type">AuthenticatorPluginResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
134+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/authenticatorpluginresult.html" class="tsd-signature-type">AuthenticatorPluginResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
138135
</li>
139136
</ul>
140137
</section>
@@ -146,55 +143,22 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
146143
<li class="globals ">
147144
<a href="../globals.html"><em>Globals</em></a>
148145
</li>
149-
<li class="current tsd-kind-external-module">
150-
<a href="../modules/_core_plugins_.html">"core/plugins"</a>
151-
</li>
152146
</ul>
153147
</nav>
154148
<nav class="tsd-navigation secondary menu-sticky">
155149
<ul class="before-current">
156150
</ul>
157151
<ul class="current">
158-
<li class="current tsd-kind-class tsd-parent-kind-external-module">
159-
<a href="_core_plugins_.anonymous.html" class="tsd-kind-icon">Anonymous</a>
152+
<li class="current tsd-kind-class">
153+
<a href="anonymous.html" class="tsd-kind-icon">Anonymous</a>
160154
<ul>
161155
<li class=" tsd-kind-method tsd-parent-kind-class">
162-
<a href="_core_plugins_.anonymous.html#authenticate" class="tsd-kind-icon">authenticate</a>
156+
<a href="anonymous.html#authenticate" class="tsd-kind-icon">authenticate</a>
163157
</li>
164158
</ul>
165159
</li>
166160
</ul>
167161
<ul class="after-current">
168-
<li class=" tsd-kind-class tsd-parent-kind-external-module">
169-
<a href="_core_plugins_.authenticatornotregistered.html" class="tsd-kind-icon">Authenticator<wbr>Not<wbr>Registered</a>
170-
</li>
171-
<li class=" tsd-kind-class tsd-parent-kind-external-module">
172-
<a href="_core_plugins_.authenticatorsmustbedecoratedwithauthenticatorpluginerror.html" class="tsd-kind-icon">Authenticators<wbr>Must<wbr>BeDecorated<wbr>With<wbr>Authenticator<wbr>Plugin<wbr>Error</a>
173-
</li>
174-
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
175-
<a href="../interfaces/_core_plugins_.authenticatorpluginresult.html" class="tsd-kind-icon">Authenticator<wbr>Plugin<wbr>Result</a>
176-
</li>
177-
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
178-
<a href="../interfaces/_core_plugins_.iauthenticator.html" class="tsd-kind-icon">IAuthenticator</a>
179-
</li>
180-
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
181-
<a href="../interfaces/_core_plugins_.iauthenticatorconstructor.html" class="tsd-kind-icon">IAuthenticator<wbr>Constructor</a>
182-
</li>
183-
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
184-
<a href="../interfaces/_core_plugins_.sakuraapiplugin.html" class="tsd-kind-icon">Sakura<wbr>Api<wbr>Plugin</a>
185-
</li>
186-
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
187-
<a href="../interfaces/_core_plugins_.sakuraapipluginresult.html" class="tsd-kind-icon">Sakura<wbr>Api<wbr>Plugin<wbr>Result</a>
188-
</li>
189-
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
190-
<a href="../modules/_core_plugins_.html#authenticationhandler" class="tsd-kind-icon">Authentication<wbr>Handler</a>
191-
</li>
192-
<li class=" tsd-kind-function tsd-parent-kind-external-module">
193-
<a href="../modules/_core_plugins_.html#authenticatorplugin" class="tsd-kind-icon">Authenticator<wbr>Plugin</a>
194-
</li>
195-
<li class=" tsd-kind-object-literal tsd-parent-kind-external-module">
196-
<a href="../modules/_core_plugins_.html#authenticatorpluginsymbols" class="tsd-kind-icon">authenticator<wbr>Plugin<wbr>Symbols</a>
197-
</li>
198162
</ul>
199163
</nav>
200164
</div>

0 commit comments

Comments
 (0)