[Bot] Documentation update (#216)

polar-rules · Dec 9, 2023 · 894e700 · 894e700
1 parent 14ef545
commit 894e700
Show file tree

Hide file tree

Showing 369 changed files with 759 additions and 757 deletions.
diff --git a/assets/search.js b/assets/search.js
diff --git a/classes/cli.Cli.Abstractions.Loader.html b/classes/cli.Cli.Abstractions.Loader.html
diff --git a/classes/cli.Cli.Abstractions.Ora.html b/classes/cli.Cli.Abstractions.Ora.html
diff --git a/classes/cli.Cli.Bear.Create.Main.html b/classes/cli.Cli.Bear.Create.Main.html
diff --git a/classes/cli.Cli.Bear.Info.Main.html b/classes/cli.Cli.Bear.Info.Main.html
diff --git a/classes/cli.Cli.Bear.Main.html b/classes/cli.Cli.Bear.Main.html
diff --git a/classes/cli.Cli.Bear.Run.Main.html b/classes/cli.Cli.Bear.Run.Main.html
diff --git a/classes/cli.Cli.Bear.Setup.Main.html b/classes/cli.Cli.Bear.Setup.Main.html
diff --git a/classes/cli.Cli.Commands.Create.Main.html b/classes/cli.Cli.Commands.Create.Main.html
diff --git a/classes/cli.Cli.Commands.Help.Main.html b/classes/cli.Cli.Commands.Help.Main.html
diff --git a/classes/cli.Cli.Commands.Info.Main.html b/classes/cli.Cli.Commands.Info.Main.html
diff --git a/classes/cli.Cli.Commands.Main.html b/classes/cli.Cli.Commands.Main.html
diff --git a/classes/cli.Cli.Commands.Run.Main.html b/classes/cli.Cli.Commands.Run.Main.html
diff --git a/classes/cli.Cli.Commands.Setup.Main.html b/classes/cli.Cli.Commands.Setup.Main.html
diff --git a/classes/cli.Cli.Core.Create.html b/classes/cli.Cli.Core.Create.html
diff --git a/classes/cli.Cli.Core.Help.html b/classes/cli.Cli.Core.Help.html
diff --git a/classes/cli.Cli.Core.Info.html b/classes/cli.Cli.Core.Info.html
diff --git a/classes/cli.Cli.Core.Run.html b/classes/cli.Cli.Core.Run.html
diff --git a/classes/cli.Cli.Core.Setup.html b/classes/cli.Cli.Core.Setup.html
diff --git a/classes/cli.Cli.Dev.Generate.Assembler.Builder.html b/classes/cli.Cli.Dev.Generate.Assembler.Builder.html
diff --git a/classes/cli.Cli.Dev.Generate.Assembler.Errors.MissingName.html b/classes/cli.Cli.Dev.Generate.Assembler.Errors.MissingName.html
diff --git a/classes/cli.Cli.Dev.Generate.Assembler.Linter.html b/classes/cli.Cli.Dev.Generate.Assembler.Linter.html
diff --git a/classes/cli.Cli.Dev.Generate.Assembler.Main.html b/classes/cli.Cli.Dev.Generate.Assembler.Main.html
diff --git a/classes/cli.Cli.Dev.Generate.Jest.Config.Main.html b/classes/cli.Cli.Dev.Generate.Jest.Config.Main.html
diff --git a/classes/core.Core.App.html b/classes/core.Core.App.html
diff --git a/classes/core.Core.ArgumentsManager.html b/classes/core.Core.ArgumentsManager.html
diff --git a/classes/core.Core.Decorators.Errors.InvalidMetadataKey.html b/classes/core.Core.Decorators.Errors.InvalidMetadataKey.html
diff --git a/classes/core.Core.Errors.CannotResolveDependencies.html b/classes/core.Core.Errors.CannotResolveDependencies.html
diff --git a/classes/core.Core.Errors.NoFactoryFound.html b/classes/core.Core.Errors.NoFactoryFound.html
diff --git a/classes/core.Core.Errors.NoSpecificTaskFound.html b/classes/core.Core.Errors.NoSpecificTaskFound.html
diff --git a/classes/core.Core.Errors.NoTasksFound.html b/classes/core.Core.Errors.NoTasksFound.html
diff --git a/classes/core.Core.Errors.NotRunnerSubclass.html b/classes/core.Core.Errors.NotRunnerSubclass.html
diff --git a/classes/core.Core.Errors.Validation.html b/classes/core.Core.Errors.Validation.html
diff --git a/classes/core.Core.Loader.html b/classes/core.Core.Loader.html
diff --git a/classes/core.Core.Perform.html b/classes/core.Core.Perform.html
diff --git a/classes/core.Core.ProjectConfiguration.Abstractions.FileResolver.html b/classes/core.Core.ProjectConfiguration.Abstractions.FileResolver.html
diff --git a/classes/core.Core.ProjectConfiguration.Entrypoint.html b/classes/core.Core.ProjectConfiguration.Entrypoint.html
diff --git a/classes/core.Core.ProjectConfiguration.Errors.MainAlreadyExist.html b/classes/core.Core.ProjectConfiguration.Errors.MainAlreadyExist.html
diff --git a/classes/core.Core.ProjectConfiguration.Errors.MissingNestCli.html b/classes/core.Core.ProjectConfiguration.Errors.MissingNestCli.html
diff --git a/classes/core.Core.ProjectConfiguration.Errors.MissingProjectConfiguration.html b/classes/core.Core.ProjectConfiguration.Errors.MissingProjectConfiguration.html
diff --git a/classes/core.Core.ProjectConfiguration.Errors.ProjectNameIsRequired.html b/classes/core.Core.ProjectConfiguration.Errors.ProjectNameIsRequired.html
diff --git a/classes/core.Core.ProjectConfiguration.Errors.TaskIsMissing.html b/classes/core.Core.ProjectConfiguration.Errors.TaskIsMissing.html
diff --git a/classes/core.Core.ProjectConfiguration.Errors.TaskIsPresentInConfig.html b/classes/core.Core.ProjectConfiguration.Errors.TaskIsPresentInConfig.html
diff --git a/classes/core.Core.ProjectConfiguration.Index.html b/classes/core.Core.ProjectConfiguration.Index.html
diff --git a/classes/core.Core.ProjectConfiguration.Main.html b/classes/core.Core.ProjectConfiguration.Main.html
diff --git a/classes/core.Core.ProjectConfiguration.Module.html b/classes/core.Core.ProjectConfiguration.Module.html
diff --git a/classes/core.Core.ProjectConfiguration.Naming.html b/classes/core.Core.ProjectConfiguration.Naming.html
diff --git a/classes/core.Core.ProjectConfiguration.Read.html b/classes/core.Core.ProjectConfiguration.Read.html
diff --git a/classes/core.Core.ProjectConfiguration.Runner.html b/classes/core.Core.ProjectConfiguration.Runner.html
diff --git a/classes/core.Core.ProjectConfiguration.Setup.html b/classes/core.Core.ProjectConfiguration.Setup.html
diff --git a/classes/core.Core.ProjectConfiguration.Task.html b/classes/core.Core.ProjectConfiguration.Task.html
diff --git a/classes/core.Core.State.html b/classes/core.Core.State.html
diff --git a/classes/core.Core.Task.html b/classes/core.Core.Task.html
diff --git a/classes/errors.Errors.Base.html b/classes/errors.Errors.Base.html
diff --git a/classes/factory.Factory.Main.html b/classes/factory.Factory.Main.html
diff --git a/classes/generators.Generators.Abstractions.FileResolver.html b/classes/generators.Generators.Abstractions.FileResolver.html
diff --git a/classes/generators.Generators.Create.html b/classes/generators.Generators.Create.html
diff --git a/classes/generators.Generators.Index.html b/classes/generators.Generators.Index.html
diff --git a/classes/generators.Generators.Runner.html b/classes/generators.Generators.Runner.html
diff --git a/classes/generators.Generators.Task.html b/classes/generators.Generators.Task.html
diff --git a/classes/patches.Patches.Json.html b/classes/patches.Patches.Json.html
diff --git a/classes/patches.Patches.Object.html b/classes/patches.Patches.Object.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Object | @polar-rules/nest-task</title><meta name="description" content="Documentation for @polar-rules/nest-task"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><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"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@polar-rules/nest-task</a></div><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"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@polar-rules/nest-task</a></li><li><a href="../modules/patches.html">patches</a></li><li><a href="../modules/patches.Patches.html">Patches</a></li><li><a href="patches.Patches.Object.html">Object</a></li></ul><h1>Class Object</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class providing utility functions related to objects.</p>
-</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type ">Object</span><ul class="tsd-hierarchy"><li><span class="target">Object</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/polar-rules/nest-task/blob/54ec14e/lib/patches/patches.object.ts#L6">lib/patches/patches.object.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="patches.Patches.Object.html#constructor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
+</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type ">Object</span><ul class="tsd-hierarchy"><li><span class="target">Object</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/polar-rules/nest-task/blob/5b980b1/lib/patches/patches.object.ts#L6">lib/patches/patches.object.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="patches.Patches.Object.html#constructor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="patches.Patches.Object.html#constructor-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>constructor</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="patches.Patches.Object.html#hasOwnProperty" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Own<wbr/>Property</span></a>
 <a href="patches.Patches.Object.html#isPrototypeOf" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Prototype<wbr/>Of</span></a>
@@ -127,7 +127,7 @@
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type tsd-kind-type-parameter">Obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4><ul>
 <li>An array of type-safe keys.</li>
 </ul>
-<div class="tsd-comment tsd-typography"><h4>Static</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/polar-rules/nest-task/blob/54ec14e/lib/patches/patches.object.ts#L15">lib/patches/patches.object.ts:15</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="values" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>values</span><a href="#values" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="values.values-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">values</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">o</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><a href="#values.values-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an array of values of the enumerable properties of an object</p>
+<div class="tsd-comment tsd-typography"><h4>Static</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/polar-rules/nest-task/blob/5b980b1/lib/patches/patches.object.ts#L15">lib/patches/patches.object.ts:15</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="values" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>values</span><a href="#values" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="values.values-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">values</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">o</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><a href="#values.values-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an array of values of the enumerable properties of an object</p>
 </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">o</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">s</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ArrayLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><p>Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.</p>
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Object.values</p><ul><li>Defined in node_modules/typescript/lib/lib.es2017.object.d.ts:24</li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="values.values-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">values</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">o</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><a href="#values.values-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an array of values of the enumerable properties of an object</p>
 </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">o</span>: <span class="tsd-signature-symbol">{}</span></h5><div class="tsd-comment tsd-typography"><p>Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.</p>

diff --git a/classes/patches.Patches.Reflect.html b/classes/patches.Patches.Reflect.html