Skip to content

Commit 4b9815c

Browse files
docs: generate API docs for component, update dgeni deps (#3258)
1 parent 49b888b commit 4b9815c

File tree

6 files changed

+403
-68
lines changed

6 files changed

+403
-68
lines changed

modules/component/src/let/let.directive.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export interface LetViewContext<T> {
2424
}
2525

2626
/**
27-
* @Directive LetDirective
27+
* @ngModule ReactiveComponentModule
2828
*
2929
* @description
3030
*
@@ -33,7 +33,7 @@ export interface LetViewContext<T> {
3333
*
3434
* The current way of binding an observable to the view looks like that:
3535
* ```html
36-
* <ng-container *ngIf="observableNumber$ as n">
36+
* <ng-container *ngIf="observableNumber$ | async as n">
3737
* <app-number [number]="n">
3838
* </app-number>
3939
* <app-number-special [number]="n">
@@ -44,12 +44,12 @@ export interface LetViewContext<T> {
4444
* The problem is `*ngIf` is also interfering with rendering and in case of a `0` the component would be hidden
4545
*
4646
* Included Features:
47-
* - binding is always present. (`*ngIf="truthy$"`)
47+
* - binding is always present. (`*ngIf="truthy$ | async"`)
4848
* - it takes away the multiple usages of the `async` or `ngrxPush` pipe
4949
* - a unified/structured way of handling null and undefined
5050
* - triggers change-detection differently if `zone.js` is present or not (`ChangeDetectorRef.detectChanges` or `ChangeDetectorRef.markForCheck`)
5151
* - triggers change-detection differently if ViewEngine or Ivy is present (`ChangeDetectorRef.detectChanges` or `ɵdetectChanges`)
52-
* - distinct same values in a row (distinctUntilChanged operator),
52+
* - distinct same values in a row (distinctUntilChanged operator)
5353
*
5454
* @usageNotes
5555
*

modules/component/src/push/push.pipe.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { CdAware, createCdAware } from '../core/cd-aware/cd-aware_creator';
1111
import { createRender } from '../core/cd-aware/creator_render';
1212

1313
/**
14-
* @Pipe PushPipe
14+
* @ngModule ReactiveComponentModule
1515
*
1616
* @description
1717
*

projects/ngrx.io/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@
108108
"codelyzer": "^6.0.1",
109109
"cross-spawn": "^5.1.0",
110110
"css-selector-parser": "^1.3.0",
111-
"dgeni": "^0.4.12",
112-
"dgeni-packages": "^0.28.4",
111+
"dgeni": "^0.4.14",
112+
"dgeni-packages": "^0.29.2",
113113
"entities": "^1.1.1",
114114
"eslint": "^3.19.0",
115115
"eslint-plugin-jasmine": "^2.2.0",

projects/ngrx.io/tools/transforms/angular-api-package/index.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
8686
'router-store/index.ts',
8787
'data/index.ts',
8888
'schematics/index.ts',
89-
'component-store/index.ts'
89+
'component-store/index.ts',
90+
'component/index.ts',
9091
];
9192

9293
readFilesProcessor.fileReaders.push(packageContentFileReader);

projects/ngrx.io/tools/transforms/authors-package/api-package.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ const packageMap = {
1717
'router-store': ['router-store/index.ts'],
1818
data: ['data/index.ts'],
1919
schematics: ['schematics/index.ts'],
20-
'component-store': ['component-store/index.ts']
20+
'component-store': ['component-store/index.ts'],
21+
component: ['component/index.ts'],
2122
};
2223

2324

0 commit comments

Comments
 (0)