docs: expose docstrings for spectator options (#741)

Author: nabeelvalley

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

@@ -11,15 +11,19 @@ import { OptionalsRequired } from '../types';
 export interface BaseSpectatorOptions {
   disableAnimations?: boolean;
   entryComponents?: Type<any>[];
+  /** Providers that will automatically be mocked */
   mocks?: Type<any>[];
   mockProvider?: MockProvider;
   providers?: any[];
   declarations?: any[];
   imports?: any[];
   schemas?: (SchemaMetadata | any[])[];
   overrideModules?: [Type<any>, MetadataOverride<NgModule>][];
+  /** Override the component's providers */
   overrideComponents?: [Type<any>, MetadataOverride<Component>][];
+  /** Override directives in case of testing standalone directive */
   overrideDirectives?: [Type<any>, MetadataOverride<Directive>][];
+  /** Override pipes in case of testing standalone pipe */
   overridePipes?: [Type<any>, MetadataOverride<Pipe>][];
   teardown?: ModuleTeardownOptions;
   deferBlockBehavior?: DeferBlockBehavior;

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

@@ -17,7 +17,9 @@ export interface SpectatorOptions<C> extends BaseSpectatorOptions {
   componentImports?: any[];
   detectChanges?: boolean;
   declareComponent?: boolean;
+  /** Component providers that will automatically be mocked */
   componentMocks?: Type<any>[];
+  /** Component view providers that will be automatically mocked */
   componentViewProvidersMocks?: Type<any>[];
 }