@ng-doc/builder 15.0.0-beta.7 → 15.0.0-beta.9

package/generated/modules/api/builder/classes/NgDocEntity/index.html

@@ -1,338 +0,0 @@
-
-<html>
-  <head></head>
-  <body>
-    <header>
-      <div class="ng-doc-page-tags">
-        <span class="ng-doc-tag" data-content="ng-doc-scope">@ng-doc/builder</span>
-        <span class="ng-doc-inline-delimiter">/</span>
-        <span class="ng-doc-tag" data-content="Class">Class</span>
-      </div><span class="ng-doc-modifier" data-content="Abstract">Abstract</span>
-      <h1 id="ngdocentity">NgDocEntity<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#ngdocentity"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h1>
-    </header>
-    <section>
-      <p>Base entity class that all entities should extend.</p>
-    </section>
-    <section>
-      <h2 id="see-also">See Also<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#see-also"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h2>
-      <ul class="ng-doc-see-also">
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocSourceFileEntity" class="ng-doc-code-anchor">NgDocSourceFileEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocSkeletonEntity" class="ng-doc-code-anchor">NgDocSkeletonEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocDependenciesEntity" class="ng-doc-code-anchor">NgDocDependenciesEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocFileEntity" class="ng-doc-code-anchor">NgDocFileEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocPlaygroundEntity" class="ng-doc-code-anchor">NgDocPlaygroundEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocModuleEntity" class="ng-doc-code-anchor">NgDocModuleEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocRouteEntity" class="ng-doc-code-anchor">NgDocRouteEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocNavigationEntity" class="ng-doc-code-anchor">NgDocNavigationEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocApiPageEntity" class="ng-doc-code-anchor">NgDocApiPageEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocApiEntity" class="ng-doc-code-anchor">NgDocApiEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocPageEntity" class="ng-doc-code-anchor">NgDocPageEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocApiScopeEntity" class="ng-doc-code-anchor">NgDocApiScopeEntity</a></code> (extended)</li>
-        <li><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocCategoryEntity" class="ng-doc-code-anchor">NgDocCategoryEntity</a></code> (extended)</li>
-      </ul>
-    </section>
-    <section>
-      <h2 id="properties">Properties<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#properties"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h2>
-      <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-properties-table">
-          <thead>
-            <tr>
-              <th class="ng-doc-properties-table-name">Name</th>
-              <th class="ng-doc-properties-table-type">Type</th>
-              <th class="ng-doc-properties-table-description">Description</th>
-            </tr>
-          </thead>
-          <tbody>
-            <tr>
-              <td><span class="ng-doc-badge-wrapper"><span class="ng-doc-badge" data-content="Abstract">A</span>
-<span class="ng-doc-badge" data-content="Readonly">R</span>
-</span>id</td>
-              <td><code>string</code></td>
-              <td>
-                <p>The key by which the entity will be stored in the store</p>
-              </td>
-            </tr>
-            <tr>
-              <td>destroyed</td>
-              <td><code>boolean</code></td>
-              <td>
-                <p>Indicates when entity was destroyed</p>
-              </td>
-            </tr>
-            <tr>
-              <td>artifacts</td>
-              <td><code class="ng-doc-code-with-link"><a href="/api/builder/interfaces/NgDocBuiltOutput" class="ng-doc-code-anchor">NgDocBuiltOutput</a>[]</code></td>
-              <td>
-                <p>Last built artifacts</p>
-              </td>
-            </tr>
-            <tr>
-              <td><span class="ng-doc-badge-wrapper"><span class="ng-doc-badge" data-content="Readonly">R</span>
-</span>dependencies</td>
-              <td><code class="ng-doc-code-with-link"><a href="/api/builder/classes/ObservableSet" class="ng-doc-code-anchor">ObservableSet</a>&#x3C;string></code></td>
-              <td>
-                <p>
-                  Collection of all file dependencies of the current entity.
-                  This property is using to watch for changes in this dependencies list and rebuild current buildable.
-                </p>
-              </td>
-            </tr>
-            <tr>
-              <td><span class="ng-doc-badge-wrapper"><span class="ng-doc-badge" data-content="Readonly">R</span>
-</span>physical</td>
-              <td><code>boolean</code></td>
-              <td>
-                <p>
-                  Indicates if this entity has physical file in file system
-                  If this entity was generated by another Entity, this property should be <code>false</code>
-                </p>
-                <p>NgDoc destroys all child elements of non-physical entities when they are destroyed</p>
-              </td>
-            </tr>
-            <tr>
-              <td><span class="ng-doc-badge-wrapper"><span class="ng-doc-badge" data-content="Abstract">A</span>
-<span class="ng-doc-badge" data-content="Readonly">R</span>
-</span>rootFiles</td>
-              <td><code>string[]</code></td>
-              <td>
-                <p>Files that are watched for changes to rebuild entity or remove it</p>
-              </td>
-            </tr>
-            <tr>
-              <td><span class="ng-doc-badge-wrapper"><span class="ng-doc-badge" data-content="Abstract">A</span>
-<span class="ng-doc-badge" data-content="Readonly">R</span>
-</span>isRoot</td>
-              <td><code>boolean</code></td>
-              <td>
-                <p>Indicates when it's root entity and should be used for rooted components.</p>
-              </td>
-            </tr>
-            <tr>
-              <td><span class="ng-doc-badge-wrapper"><span class="ng-doc-badge" data-content="Abstract">A</span>
-<span class="ng-doc-badge" data-content="Readonly">R</span>
-</span>parent</td>
-              <td><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocEntity" class="ng-doc-code-anchor">NgDocEntity</a> | undefined</code></td>
-              <td>
-                <p>Should return the parent of the current entity</p>
-              </td>
-            </tr>
-            <tr>
-              <td><span class="ng-doc-badge-wrapper"><span class="ng-doc-badge" data-content="Abstract">A</span>
-<span class="ng-doc-badge" data-content="Readonly">R</span>
-</span>buildCandidates</td>
-              <td><code class="ng-doc-code-with-link"><a href="/api/builder/classes/NgDocEntity" class="ng-doc-code-anchor">NgDocEntity</a>[]</code></td>
-              <td>
-                <p>Should return the list of the dependencies that have to be built if current entity was changed.</p>
-              </td>
-            </tr>
-          </tbody>
-        </table>
-      </div>
-    </section>
-    <section>
-      <h2 id="methods">Methods<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#methods"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h2>
-      <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-          <thead>
-            <tr>
-              <th>
-                <h3 id="update">update<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#update"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h3>
-                <div class="ng-doc-modifiers-wrapper"><span class="ng-doc-modifier" data-content="Abstract">Abstract</span></div>
-              </th>
-            </tr>
-          </thead>
-          <tbody>
-            <tr>
-              <td>
-                <p>Runs when the source file was updated, can be used to refresh target file etc.</p>
-              </td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="presentation">Presentation</h5>
-                <pre><code lang="typescript" class="hljs language-typescript"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">update</span>(<span class="hljs-params"></span>): <span class="hljs-title">Observable</span>&#x3C;<span class="hljs-title">void</span>></span>;</code></pre>
-              </td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="returns">Returns</h5>
-                <p><code>Observable&#x3C;void></code></p>
-              </td>
-            </tr>
-          </tbody>
-        </table>
-      </div>
-      <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-          <thead>
-            <tr>
-              <th>
-                <h3 id="childrengenerator">childrenGenerator<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#childrengenerator"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h3>
-              </th>
-            </tr>
-          </thead>
-          <tbody>
-            <tr>
-              <td>No documentation has been provided.</td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="presentation-1">Presentation</h5>
-                <pre><code lang="typescript" class="hljs language-typescript"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">childrenGenerator</span>(<span class="hljs-params"></span>): <span class="hljs-title">Observable</span>&#x3C;<span class="hljs-title"><a href="/api/builder/classes/NgDocEntity" class="ng-doc-code-anchor">NgDocEntity</a></span>[]></span>;</code></pre>
-              </td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="returns-1">Returns</h5>
-                <p><code class="ng-doc-code-with-link">Observable&#x3C;<a href="/api/builder/classes/NgDocEntity" class="ng-doc-code-anchor">NgDocEntity</a>[]></code></p>
-              </td>
-            </tr>
-          </tbody>
-        </table>
-      </div>
-      <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-          <thead>
-            <tr>
-              <th>
-                <h3 id="buildartifacts">buildArtifacts<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#buildartifacts"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h3>
-              </th>
-            </tr>
-          </thead>
-          <tbody>
-            <tr>
-              <td>No documentation has been provided.</td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="presentation-2">Presentation</h5>
-                <pre><code lang="typescript" class="hljs language-typescript"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">buildArtifacts</span>(<span class="hljs-params"></span>): <span class="hljs-title">Observable</span>&#x3C;<span class="hljs-title"><a href="/api/builder/interfaces/NgDocBuiltOutput" class="ng-doc-code-anchor">NgDocBuiltOutput</a></span>[]></span>;</code></pre>
-              </td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="returns-2">Returns</h5>
-                <p><code class="ng-doc-code-with-link">Observable&#x3C;<a href="/api/builder/interfaces/NgDocBuiltOutput" class="ng-doc-code-anchor">NgDocBuiltOutput</a>[]></code></p>
-              </td>
-            </tr>
-          </tbody>
-        </table>
-      </div>
-      <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-          <thead>
-            <tr>
-              <th>
-                <h3 id="emit">emit<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#emit"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h3>
-              </th>
-            </tr>
-          </thead>
-          <tbody>
-            <tr>
-              <td>No documentation has been provided.</td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="presentation-3">Presentation</h5>
-                <pre><code lang="typescript" class="hljs language-typescript"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">emit</span>(<span class="hljs-params"></span>): <span class="hljs-title">Observable</span>&#x3C;<span class="hljs-title">void</span>></span>;</code></pre>
-              </td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="returns-3">Returns</h5>
-                <p><code>Observable&#x3C;void></code></p>
-              </td>
-            </tr>
-          </tbody>
-        </table>
-      </div>
-      <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-          <thead>
-            <tr>
-              <th>
-                <h3 id="removeartifacts">removeArtifacts<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#removeartifacts"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h3>
-              </th>
-            </tr>
-          </thead>
-          <tbody>
-            <tr>
-              <td>No documentation has been provided.</td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="presentation-4">Presentation</h5>
-                <pre><code lang="typescript" class="hljs language-typescript"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">removeArtifacts</span>(<span class="hljs-params"></span>): <span class="hljs-title">void</span></span>;</code></pre>
-              </td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="returns-4">Returns</h5>
-                <p><code>void</code></p>
-              </td>
-            </tr>
-          </tbody>
-        </table>
-      </div>
-      <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-          <thead>
-            <tr>
-              <th>
-                <h3 id="destroy">destroy<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#destroy"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h3>
-              </th>
-            </tr>
-          </thead>
-          <tbody>
-            <tr>
-              <td>
-                <p>Destroys current entity and clear all references</p>
-                <p>{void}</p>
-              </td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="presentation-5">Presentation</h5>
-                <pre><code lang="typescript" class="hljs language-typescript"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">destroy</span>(<span class="hljs-params"></span>): <span class="hljs-title">void</span></span>;</code></pre>
-              </td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="returns-5">Returns</h5>
-                <p><code>void</code></p>
-              </td>
-            </tr>
-          </tbody>
-        </table>
-      </div>
-      <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-          <thead>
-            <tr>
-              <th>
-                <h3 id="ondestroy">onDestroy<a title="Link to heading" class="ng-doc-header-link" href="/api/builder/classes/NgDocEntity#ondestroy"><ng-doc-icon icon="link-2" size="16"></ng-doc-icon></a></h3>
-              </th>
-            </tr>
-          </thead>
-          <tbody>
-            <tr>
-              <td>No documentation has been provided.</td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="presentation-6">Presentation</h5>
-                <pre><code lang="typescript" class="hljs language-typescript"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">onDestroy</span>(<span class="hljs-params"></span>): <span class="hljs-title">Observable</span>&#x3C;<span class="hljs-title">void</span>></span>;</code></pre>
-              </td>
-            </tr>
-            <tr>
-              <td>
-                <h5 class="no-anchor" id="returns-6">Returns</h5>
-                <p><code>Observable&#x3C;void></code></p>
-              </td>
-            </tr>
-          </tbody>
-        </table>
-      </div>
-    </section>
-  </body>
-</html>

package/generated/modules/api/builder/classes/NgDocEntity/ng-doc-api-page567.module.ts

@@ -1,36 +0,0 @@
-// @ts-nocheck
-import {ChangeDetectionStrategy, Component, NgModule, Type} from "@angular/core";
-import {RouterModule} from "@angular/router";
-import {CommonModule} from '@angular/common';
-import {NgDocDemoAssets, NgDocPageModule, NgDocRootPage} from '@ng-doc/app';
-import pageContent from '!!raw-loader!dist/libs/builder/generated/modules/api/builder/classes/NgDocEntity/index.html';
-
-@Component({
-	template: `<ng-doc-page></ng-doc-page>`,
-	changeDetection: ChangeDetectionStrategy.OnPush,
-	providers: [{provide: NgDocRootPage, useExisting: NgDocGeneratedApiPageComponent566}],
-})
-export class NgDocGeneratedApiPageComponent566 extends NgDocRootPage {
-	readonly pageContent: string = pageContent;
-	readonly demo: Record<string, Type<unknown>> | undefined = undefined;
-	readonly demoAssets: NgDocDemoAssets | undefined = undefined;
-
-	constructor() {
-		super();
-	}
-}
-
-@NgModule({
-	declarations: [NgDocGeneratedApiPageComponent566],
-	imports: [
-		CommonModule,
-		NgDocPageModule,
-		RouterModule.forChild([{
-			path: '',
-			component: NgDocGeneratedApiPageComponent566,
-		}]),
-	],
-	exports: [RouterModule]
-})
-export class NgDocGeneratedApiPageModule565 {
-}