docs: generate API docs for component, update dgeni deps (#3258)

ngrx · Dec 4, 2021 · 4b9815c · 4b9815c
1 parent 49b888b
commit 4b9815c
Show file tree

Hide file tree

Showing 6 changed files with 403 additions and 68 deletions.
diff --git a/modules/component/src/let/let.directive.ts b/modules/component/src/let/let.directive.ts
@@ -24,7 +24,7 @@ export interface LetViewContext<T> {
 }
 
 /**
- * @Directive LetDirective
+ * @ngModule ReactiveComponentModule
  *
  * @description
  *
@@ -33,7 +33,7 @@ export interface LetViewContext<T> {
  *
  * The current way of binding an observable to the view looks like that:
  * ```html
- * <ng-container *ngIf="observableNumber$ as n">
+ * <ng-container *ngIf="observableNumber$ | async as n">
  * <app-number [number]="n">
  * </app-number>
  * <app-number-special [number]="n">
@@ -44,12 +44,12 @@ export interface LetViewContext<T> {
  *  The problem is `*ngIf` is also interfering with rendering and in case of a `0` the component would be hidden
  *
  * Included Features:
- * - binding is always present. (`*ngIf="truthy$"`)
+ * - binding is always present. (`*ngIf="truthy$ | async"`)
  * - it takes away the multiple usages of the `async` or `ngrxPush` pipe
  * - a unified/structured way of handling null and undefined
  * - triggers change-detection differently if `zone.js` is present or not (`ChangeDetectorRef.detectChanges` or `ChangeDetectorRef.markForCheck`)
  * - triggers change-detection differently if ViewEngine or Ivy is present (`ChangeDetectorRef.detectChanges` or `ɵdetectChanges`)
- * - distinct same values in a row (distinctUntilChanged operator),
+ * - distinct same values in a row (distinctUntilChanged operator)
  *
  * @usageNotes
  *

diff --git a/modules/component/src/push/push.pipe.ts b/modules/component/src/push/push.pipe.ts
@@ -11,7 +11,7 @@ import { CdAware, createCdAware } from '../core/cd-aware/cd-aware_creator';
 import { createRender } from '../core/cd-aware/creator_render';
 
 /**
- * @Pipe PushPipe
+ * @ngModule ReactiveComponentModule
  *
  * @description
  *

diff --git a/projects/ngrx.io/package.json b/projects/ngrx.io/package.json
@@ -108,8 +108,8 @@
     "codelyzer": "^6.0.1",
     "cross-spawn": "^5.1.0",
     "css-selector-parser": "^1.3.0",
-    "dgeni": "^0.4.12",
-    "dgeni-packages": "^0.28.4",
+    "dgeni": "^0.4.14",
+    "dgeni-packages": "^0.29.2",
     "entities": "^1.1.1",
     "eslint": "^3.19.0",
     "eslint-plugin-jasmine": "^2.2.0",

diff --git a/projects/ngrx.io/tools/transforms/angular-api-package/index.js b/projects/ngrx.io/tools/transforms/angular-api-package/index.js
@@ -86,7 +86,8 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
       'router-store/index.ts',
       'data/index.ts',
       'schematics/index.ts',
-      'component-store/index.ts'
+      'component-store/index.ts',
+      'component/index.ts',
     ];
 
     readFilesProcessor.fileReaders.push(packageContentFileReader);

diff --git a/projects/ngrx.io/tools/transforms/authors-package/api-package.js b/projects/ngrx.io/tools/transforms/authors-package/api-package.js
@@ -17,7 +17,8 @@ const packageMap = {
   'router-store': ['router-store/index.ts'],
   data: ['data/index.ts'],
   schematics: ['schematics/index.ts'],
-  'component-store': ['component-store/index.ts']
+  'component-store': ['component-store/index.ts'],
+  component: ['component/index.ts'],
 };