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

Commit 4c51f2a

Browse files
etsuoetsuo
committed
1 parent 6b7b95c commit 4c51f2a

64 files changed

Lines changed: 6232 additions & 940 deletions

File tree

Some content is hidden

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

‎docs/assets/css/main.css‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,7 @@ table { border-collapse: collapse; border-spacing: 0; }
556556
.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -187px; }
557557
.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -187px; }
558558

559-
.no-transition { -webkit-transition: none !important; transition: none !important; }
559+
.no-transition { transition: none !important; }
560560

561561
@-webkit-keyframes fade-in { from { opacity: 0; }
562562
to { opacity: 1; } }
@@ -713,7 +713,7 @@ footer .tsd-legend { display: inline-block; width: 25%; padding: 0; font-size: 1
713713
.tsd-member .tsd-anchor + h3 { margin-top: 0; margin-bottom: 0; border-bottom: none; }
714714

715715
.tsd-navigation { padding: 0 0 0 40px; }
716-
.tsd-navigation a { display: block; padding-top: 2px; padding-bottom: 2px; border-left: 2px solid transparent; color: #222; text-decoration: none; -webkit-transition: border-left-color 0.1s; transition: border-left-color 0.1s; }
716+
.tsd-navigation a { display: block; padding-top: 2px; padding-bottom: 2px; border-left: 2px solid transparent; color: #222; text-decoration: none; transition: border-left-color 0.1s; }
717717
.tsd-navigation a:hover { text-decoration: underline; }
718718
.tsd-navigation ul { margin: 0; padding: 0; list-style: none; }
719719
.tsd-navigation li { padding: 0; }
@@ -732,7 +732,7 @@ footer .tsd-legend { display: inline-block; width: 25%; padding: 0; font-size: 1
732732
.tsd-navigation.primary li.label span { display: block; padding: 20px 0 6px 5px; color: #808080; }
733733
.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { padding-top: 20px; }
734734

735-
.tsd-navigation.secondary ul { -webkit-transition: opacity 0.2s; transition: opacity 0.2s; }
735+
.tsd-navigation.secondary ul { transition: opacity 0.2s; }
736736
.tsd-navigation.secondary ul li a { padding-left: 25px; }
737737
.tsd-navigation.secondary ul li li a { padding-left: 45px; }
738738
.tsd-navigation.secondary ul li li li a { padding-left: 65px; }
@@ -765,12 +765,12 @@ footer .tsd-legend { display: inline-block; width: 25%; padding: 0; font-size: 1
765765
.tsd-panel-group { margin: 60px 0; }
766766
.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { padding-left: 20px; padding-right: 20px; }
767767

768-
#tsd-search { -webkit-transition: background-color 0.2s; transition: background-color 0.2s; }
768+
#tsd-search { transition: background-color 0.2s; }
769769
#tsd-search .title { position: relative; z-index: 2; }
770770
#tsd-search .field { position: absolute; left: 0; top: 0; right: 40px; height: 40px; }
771771
#tsd-search .field input { box-sizing: border-box; position: relative; top: -50px; z-index: 1; width: 100%; padding: 0 10px; opacity: 0; outline: 0; border: 0; background: transparent; color: #222; }
772772
#tsd-search .field label { position: absolute; overflow: hidden; right: -40px; }
773-
#tsd-search .field input, #tsd-search .title { -webkit-transition: opacity 0.2s; transition: opacity 0.2s; }
773+
#tsd-search .field input, #tsd-search .title { transition: opacity 0.2s; }
774774
#tsd-search .results { position: absolute; visibility: hidden; top: 40px; width: 100%; margin: 0; padding: 0; list-style: none; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); }
775775
#tsd-search .results li { padding: 0 10px; background-color: #fdfdfd; }
776776
#tsd-search .results li:nth-child(even) { background-color: #fff; }
@@ -798,7 +798,7 @@ footer .tsd-legend { display: inline-block; width: 25%; padding: 0; font-size: 1
798798
.tsd-signature-type { font-style: italic; font-weight: normal; }
799799

800800
.tsd-signatures { padding: 0; margin: 0 0 1em 0; border: 1px solid #eee; }
801-
.tsd-signatures .tsd-signature { margin: 0; border-width: 1px 0 0 0; -webkit-transition: background-color 0.1s; transition: background-color 0.1s; }
801+
.tsd-signatures .tsd-signature { margin: 0; border-width: 1px 0 0 0; transition: background-color 0.1s; }
802802
.tsd-signatures .tsd-signature:first-child { border-top-width: 0; }
803803
.tsd-signatures .tsd-signature.current { background-color: #eee; }
804804
.tsd-signatures.active > .tsd-signature { cursor: pointer; }
@@ -807,7 +807,7 @@ footer .tsd-legend { display: inline-block; width: 25%; padding: 0; font-size: 1
807807
.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { left: 20px; }
808808
.tsd-panel > a.anchor + .tsd-signatures { border-top-width: 0; margin-top: -20px; }
809809

810-
ul.tsd-descriptions { position: relative; overflow: hidden; -webkit-transition: height 0.3s; transition: height 0.3s; padding: 0; list-style: none; }
810+
ul.tsd-descriptions { position: relative; overflow: hidden; transition: height 0.3s; padding: 0; list-style: none; }
811811
ul.tsd-descriptions.active > .tsd-description { display: none; }
812812
ul.tsd-descriptions.active > .tsd-description.current { display: block; }
813813
ul.tsd-descriptions.active > .tsd-description.fade-in { -webkit-animation: fade-in-delayed 0.3s; animation: fade-in-delayed 0.3s; }
@@ -835,7 +835,7 @@ ul.tsd-parameters .tsd-comment, ul.tsd-type-parameters .tsd-comment { margin-top
835835
.tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { content: ""; display: inline-block; width: 40px; height: 40px; margin: 0 -8px 0 0; background-image: url(../images/widgets.png); background-repeat: no-repeat; text-indent: -1024px; vertical-align: bottom; }
836836
@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { .tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { background-image: url(../images/widgets@2x.png); background-size: 320px 40px; } }
837837

838-
.tsd-widget { display: inline-block; overflow: hidden; opacity: 0.6; height: 40px; -webkit-transition: opacity 0.1s, background-color 0.2s; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; }
838+
.tsd-widget { display: inline-block; overflow: hidden; opacity: 0.6; height: 40px; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; }
839839
.tsd-widget:hover { opacity: 0.8; }
840840
.tsd-widget.active { opacity: 1; background-color: #eee; }
841841
.tsd-widget.no-caption { width: 40px; }
@@ -848,12 +848,12 @@ ul.tsd-parameters .tsd-comment, ul.tsd-type-parameters .tsd-comment { margin-top
848848
input[type=checkbox] + .tsd-widget:before { background-position: -120px 0; }
849849
input[type=checkbox]:checked + .tsd-widget:before { background-position: -160px 0; }
850850

851-
.tsd-select { position: relative; display: inline-block; height: 40px; -webkit-transition: opacity 0.1s, background-color 0.2s; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; }
852-
.tsd-select .tsd-select-label { opacity: 0.6; -webkit-transition: opacity 0.2s; transition: opacity 0.2s; }
851+
.tsd-select { position: relative; display: inline-block; height: 40px; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; }
852+
.tsd-select .tsd-select-label { opacity: 0.6; transition: opacity 0.2s; }
853853
.tsd-select .tsd-select-label:before { background-position: -240px 0; }
854854
.tsd-select.active .tsd-select-label { opacity: 0.8; }
855-
.tsd-select.active .tsd-select-list { visibility: visible; opacity: 1; -webkit-transition-delay: 0s; transition-delay: 0s; }
856-
.tsd-select .tsd-select-list { position: absolute; visibility: hidden; top: 40px; left: 0; margin: 0; padding: 0; opacity: 0; list-style: none; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -webkit-transition: visibility 0s 0.2s, opacity 0.2s; transition: visibility 0s 0.2s, opacity 0.2s; }
855+
.tsd-select.active .tsd-select-list { visibility: visible; opacity: 1; transition-delay: 0s; }
856+
.tsd-select .tsd-select-list { position: absolute; visibility: hidden; top: 40px; left: 0; margin: 0; padding: 0; opacity: 0; list-style: none; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); transition: visibility 0s 0.2s, opacity 0.2s; }
857857
.tsd-select .tsd-select-list li { padding: 0 20px 0 0; background-color: #fdfdfd; }
858858
.tsd-select .tsd-select-list li:before { background-position: 40px 0; }
859859
.tsd-select .tsd-select-list li:nth-child(even) { background-color: #fff; }

‎docs/classes/_boot_sakura_api_config_.sakuraapiconfig.html‎

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ <h1>Class SakuraApiConfig</h1>
7070
<section class="tsd-panel tsd-comment">
7171
<div class="tsd-comment tsd-typography">
7272
<div class="lead">
73-
<p>SakuraApiConfig loads and manages the cascading configuration files of SakuraApi.</p>
73+
<p>SakuraApiConfig loads and manages the cascading configuration files of SakuraApi. The configuration is deep
74+
merged. See <a href="_boot_sakura_api_config_.sakuraapiconfig.html#load">SakuraApiConfig.load</a> for details.</p>
7475
</div>
7576
</div>
7677
</section>
@@ -121,7 +122,7 @@ <h3>constructor</h3>
121122
<li class="tsd-description">
122123
<aside class="tsd-sources">
123124
<ul>
124-
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/43318ee/boot/sakura-api-config.ts#L23">boot/sakura-api-config.ts:23</a></li>
125+
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/6b7b95c/src/boot/sakura-api-config.ts#L48">boot/sakura-api-config.ts:48</a></li>
125126
</ul>
126127
</aside>
127128
<div class="tsd-comment tsd-typography">
@@ -142,7 +143,7 @@ <h3>config</h3>
142143
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
143144
<aside class="tsd-sources">
144145
<ul>
145-
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/43318ee/boot/sakura-api-config.ts#L17">boot/sakura-api-config.ts:17</a></li>
146+
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/6b7b95c/src/boot/sakura-api-config.ts#L48">boot/sakura-api-config.ts:48</a></li>
146147
</ul>
147148
</aside>
148149
<div class="tsd-comment tsd-typography">
@@ -165,7 +166,7 @@ <h3>data<wbr>Sources</h3>
165166
<li class="tsd-description">
166167
<aside class="tsd-sources">
167168
<ul>
168-
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/43318ee/boot/sakura-api-config.ts#L54">boot/sakura-api-config.ts:54</a></li>
169+
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/6b7b95c/src/boot/sakura-api-config.ts#L79">boot/sakura-api-config.ts:79</a></li>
169170
</ul>
170171
</aside>
171172
<div class="tsd-comment tsd-typography">
@@ -212,15 +213,15 @@ <h3>load</h3>
212213
<li class="tsd-description">
213214
<aside class="tsd-sources">
214215
<ul>
215-
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/43318ee/boot/sakura-api-config.ts#L82">boot/sakura-api-config.ts:82</a></li>
216+
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/6b7b95c/src/boot/sakura-api-config.ts#L108">boot/sakura-api-config.ts:108</a></li>
216217
</ul>
217218
</aside>
218219
<div class="tsd-comment tsd-typography">
219220
<div class="lead">
220-
<p>loads the config file specified by path. If no path is provided, load the path/filename defined in environmental variable SAKURA_API_CONFIG,
221-
otherwise load <code>config/environment.json</code> from the root of the project.</p>
221+
<p>Loads the config file specified by path. If no path is provided, load the path/filename defined in environmental
222+
variable SAKURA_API_CONFIG, otherwise load <code>config/environment.json</code> from the root of the project.</p>
222223
</div>
223-
<p> SakuraApi looks for a config/ folder in the root of your api project.
224+
<p>SakuraApi looks for a config/ folder in the root of your api project.
224225
It cascades the values found in the following order (the last taking precedence over the former):</p>
225226
<ul>
226227
<li>environment.json</li>
@@ -229,7 +230,8 @@ <h3>load</h3>
229230
<li>environment.{env}.ts</li>
230231
<li>system environmental variables</li>
231232
</ul>
232-
<p>Where <code>{env}</code> is replaced by what&#39;s set in the environmental variable <code>NODE_ENV</code>. For example, if your set <code>NODE_ENV=dev</code> when you start your server, the system will load:</p>
233+
<p>Where <code>{env}</code> is replaced by what&#39;s set in the environmental variable <code>NODE_ENV</code>. For example, if your set
234+
<code>NODE_ENV=dev</code> when you start your server, the system will load:</p>
233235
<ul>
234236
<li>environment.json</li>
235237
<li>environment.ts</li>
@@ -258,7 +260,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> data<wbr>Sources</h3>
258260
<li class="tsd-description">
259261
<aside class="tsd-sources">
260262
<ul>
261-
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/43318ee/boot/sakura-api-config.ts#L189">boot/sakura-api-config.ts:189</a></li>
263+
<li>Defined in <a href="https://github.com/sakuraapi/api/blob/6b7b95c/src/boot/sakura-api-config.ts#L20">boot/sakura-api-config.ts:20</a></li>
262264
</ul>
263265
</aside>
264266
<div class="tsd-comment tsd-typography">
@@ -273,7 +275,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
273275
<h5>config: <span class="tsd-signature-type">object</span></h5>
274276
<ul class="tsd-parameters">
275277
<li class="tsd-parameter">
276-
<h5>db<wbr>Connections<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
278+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> db<wbr>Connections<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
277279
</li>
278280
</ul>
279281
</li>
@@ -293,6 +295,12 @@ <h4 class="tsd-returns-title">Returns <a href="_core_sakura_mongo_db_connection_
293295
<li class="current tsd-kind-external-module">
294296
<a href="../modules/_boot_sakura_api_config_.html">"boot/sakura-<wbr>api-<wbr>config"</a>
295297
</li>
298+
<li class=" tsd-kind-external-module">
299+
<a href="../modules/_core__injectable_injectable_.html">"core/@injectable/injectable"</a>
300+
</li>
301+
<li class=" tsd-kind-external-module">
302+
<a href="../modules/_core__injectable_sakura_api_injectable_.html">"core/@injectable/sakura-<wbr>api-<wbr>injectable"</a>
303+
</li>
296304
<li class=" tsd-kind-external-module">
297305
<a href="../modules/_core__model_db_.html">"core/@model/db"</a>
298306
</li>
@@ -323,6 +331,12 @@ <h4 class="tsd-returns-title">Returns <a href="_core_sakura_mongo_db_connection_
323331
<li class=" tsd-kind-external-module">
324332
<a href="../modules/_core_helpers_defaultmethodhelpers_.html">"core/helpers/default<wbr>Method<wbr>Helpers"</a>
325333
</li>
334+
<li class=" tsd-kind-external-module">
335+
<a href="../modules/_core_helpers_http_status_.html">"core/helpers/http-<wbr>status"</a>
336+
</li>
337+
<li class=" tsd-kind-external-module">
338+
<a href="../modules/_core_helpers_should_recurse_.html">"core/helpers/should-<wbr>recurse"</a>
339+
</li>
326340
<li class=" tsd-kind-external-module">
327341
<a href="../modules/_core_sakura_api_.html">"core/sakura-<wbr>api"</a>
328342
</li>
@@ -332,6 +346,9 @@ <h4 class="tsd-returns-title">Returns <a href="_core_sakura_mongo_db_connection_
332346
<li class=" tsd-kind-external-module">
333347
<a href="../modules/_core_security_mongo_db_.html">"core/security/mongo-<wbr>db"</a>
334348
</li>
349+
<li class=" tsd-kind-external-module">
350+
<a href="../modules/_handlers_basic_handlers_.html">"handlers/basic-<wbr>handlers"</a>
351+
</li>
335352
</ul>
336353
</nav>
337354
<nav class="tsd-navigation secondary menu-sticky">
@@ -360,6 +377,9 @@ <h4 class="tsd-returns-title">Returns <a href="_core_sakura_mongo_db_connection_
360377
</li>
361378
</ul>
362379
<ul class="after-current">
380+
<li class=" tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported">
381+
<a href="../modules/_boot_sakura_api_config_.html#debug" class="tsd-kind-icon">debug</a>
382+
</li>
363383
</ul>
364384
</nav>
365385
</div>

0 commit comments

Comments
 (0)