Skip to content

Commit

Permalink
Deploying to gh-pages from @ c453ba9 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
moontai0724 committed Oct 9, 2024
1 parent e7b89fc commit 9805ed9
Show file tree
Hide file tree
Showing 9 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion functions/getAnyOption.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion functions/getArrayOption.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion functions/getBooleanOption.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion functions/getChoiceOption.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion functions/getNumberOption.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion functions/getOption.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="getOption.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/_internal_.TSchema.html" class="tsd-signature-type tsd-kind-interface">TSchema</a></span></li><li><span><a id="getOption.O" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">O</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/_internal_.Options.html" class="tsd-signature-type tsd-kind-interface">Options</a> = <span class="tsd-signature-type">object</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">schema</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="getOption.html#getOption.T">T</a></span><div class="tsd-comment tsd-typography"><p>Any TypeBox schema that could be transformed to yargs options.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">overwrites</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="getOption.html#getOption.O">O</a></span><div class="tsd-comment tsd-typography"><p>overwrites for yargs options result</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="getOption.html#getOption.T">T</a><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/_internal_.TNumber.html" class="tsd-signature-type tsd-kind-interface">TNumber</a><br/><span>    </span><span class="tsd-signature-symbol">? </span><a href="../types/_internal_.ReturnType.html" class="tsd-signature-type tsd-kind-type-alias">ReturnType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">typeof </span><a href="getNumberOption.html" class="tsd-signature-type tsd-kind-function">getNumberOption</a><span class="tsd-signature-symbol">&gt;</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="getOption.html#getOption.T">T</a><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/_internal_.TString.html" class="tsd-signature-type tsd-kind-interface">TString</a><br/><span>        </span><span class="tsd-signature-symbol">? </span><a href="../types/_internal_.ReturnType.html" class="tsd-signature-type tsd-kind-type-alias">ReturnType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">typeof </span><a href="getStringOption.html" class="tsd-signature-type tsd-kind-function">getStringOption</a><span class="tsd-signature-symbol">&gt;</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="getOption.html#getOption.T">T</a><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/_internal_.TBoolean.html" class="tsd-signature-type tsd-kind-interface">TBoolean</a><br/><span>            </span><span class="tsd-signature-symbol">? </span><a href="../types/_internal_.ReturnType.html" class="tsd-signature-type tsd-kind-type-alias">ReturnType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">typeof </span><a href="getBooleanOption.html" class="tsd-signature-type tsd-kind-function">getBooleanOption</a><span class="tsd-signature-symbol">&gt;</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="getOption.html#getOption.T">T</a><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/_internal_.TUnion.html" class="tsd-signature-type tsd-kind-interface">TUnion</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.TLiteral.html" class="tsd-signature-type tsd-kind-interface">TLiteral</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><a href="../types/_internal_.ReturnType.html" class="tsd-signature-type tsd-kind-type-alias">ReturnType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">typeof </span><a href="getChoiceOption.html" class="tsd-signature-type tsd-kind-function">getChoiceOption</a><span class="tsd-signature-symbol">&gt;</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="getOption.html#getOption.T">T</a><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/_internal_.TArray.html" class="tsd-signature-type tsd-kind-interface">TArray</a><br/><span>                    </span><span class="tsd-signature-symbol">? </span><a href="../types/_internal_.ReturnType.html" class="tsd-signature-type tsd-kind-type-alias">ReturnType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">typeof </span><a href="getArrayOption.html" class="tsd-signature-type tsd-kind-function">getArrayOption</a><span class="tsd-signature-symbol">&gt;</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="getOption.html#getOption.O">O</a></h4><p>applicable yargs options in schema and overwrites</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/moontaiworks/yargs-typebox/blob/90c579c18ad1bbdd68b109159137e1af14b100ba/src/get-option.ts#L41">src/get-option.ts:41</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><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"><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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>yargs-typebox</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/moontaiworks/yargs-typebox/blob/5e69a5d55d4c2ad2ba1ccabda37b1a996a7012bc/src/get-option.ts#L41">src/get-option.ts:41</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><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"><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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>yargs-typebox</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
2 changes: 1 addition & 1 deletion functions/getOptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="getOptions.Schema" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/_internal_.TObject.html" class="tsd-signature-type tsd-kind-interface">TObject</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/_internal_.TProperties.html" class="tsd-signature-type tsd-kind-type-alias">TProperties</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">schema</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="getOptions.html#getOptions.Schema">Schema</a></span><div class="tsd-comment tsd-typography"><p>TypeBox TObject schema to transform as multiple yargs options,
as key be the name and the value be the schema</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/_internal_.Record.html" class="tsd-signature-type tsd-kind-type-alias">Record</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof </span><a href="../types/_internal_.Static.html" class="tsd-signature-type tsd-kind-type-alias">Static</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="getOptions.html#getOptions.Schema">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/_internal_.Options.html" class="tsd-signature-type tsd-kind-interface">Options</a><span class="tsd-signature-symbol">&gt;</span></h4><p>transformed object of yargs options</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/moontaiworks/yargs-typebox/blob/90c579c18ad1bbdd68b109159137e1af14b100ba/src/get-options.ts#L17">src/get-options.ts:17</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><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"><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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>yargs-typebox</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/moontaiworks/yargs-typebox/blob/5e69a5d55d4c2ad2ba1ccabda37b1a996a7012bc/src/get-options.ts#L17">src/get-options.ts:17</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><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"><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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>yargs-typebox</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Loading

0 comments on commit 9805ed9

Please sign in to comment.