Skip to content

Commit ebfed3c

Browse files
authored
docs: add remaining readme docstrings for spectatoroptions (#742)
1 parent 0b1d909 commit ebfed3c

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

projects/spectator/src/lib/base/options.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import { OptionalsRequired } from '../types';
99
* @internal
1010
*/
1111
export interface BaseSpectatorOptions {
12+
/** @default true */
1213
disableAnimations?: boolean;
1314
entryComponents?: Type<any>[];
1415
/** Providers that will automatically be mocked */

projects/spectator/src/lib/spectator/options.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,19 @@ import { OptionalsRequired } from '../types';
99
*/
1010
export interface SpectatorOptions<C> extends BaseSpectatorOptions {
1111
component: Type<C>;
12+
/** @default false */
1213
shallow?: boolean;
1314
/** set options for TestBed.createComponent(component, options: TestComponentOptions) */
1415
bindings?: Binding[]; // TestComponentOptions['bindings'];
16+
/** Override the component's providers */
1517
componentProviders?: any[];
18+
/** Override the component's view providers */
1619
componentViewProviders?: any[];
20+
/** Override the component's imports in case of testing standalone component */
1721
componentImports?: any[];
22+
/** @default true */
1823
detectChanges?: boolean;
24+
/** @default true */
1925
declareComponent?: boolean;
2026
/** Component providers that will automatically be mocked */
2127
componentMocks?: Type<any>[];

0 commit comments

Comments
 (0)