add jsdoc, export TextOptions interface

Author: annieyw

src/cdk/testing/protractor/protractor-element.ts

@@ -10,7 +10,7 @@ import {
   ElementDimensions,
   ModifierKeys,
   TestElement,
-  TestKey
+  TestKey, TextOptions
 } from '@angular/cdk/testing';
 import {browser, ElementFinder, Key} from 'protractor';
 import {getTextWithExcludedElements} from '@angular/cdk/testing/text-filtering';
@@ -135,7 +135,7 @@ export class ProtractorElement implements TestElement {
     return this.element.sendKeys(...keys);
   }
 
-  async text(options?: {exclude?: string}): Promise<string> {
+  async text(options?: TextOptions): Promise<string> {
     if (options?.exclude) {
       return browser.executeScript(getTextWithExcludedElements, this.element, options.exclude);
     }

src/cdk/testing/test-element.ts

@@ -133,7 +133,7 @@ export interface TestElement {
   isFocused(): Promise<boolean>;
 }
 
-interface TextOptions {
+export interface TextOptions {
   /** Optional selector for elements to exclude. */
   exclude?: string
 }

src/cdk/testing/testbed/unit-test-element.ts

@@ -11,7 +11,7 @@ import {
   ElementDimensions,
   ModifierKeys,
   TestElement,
-  TestKey
+  TestKey, TextOptions
 } from '@angular/cdk/testing';
 import {
   clearElement,
@@ -132,7 +132,7 @@ export class UnitTestElement implements TestElement {
     await this._stabilize();
   }
 
-  async text(options?: {exclude?: string}): Promise<string> {
+  async text(options?:TextOptions): Promise<string> {
     await this._stabilize();
     if (options?.exclude) {
       return getTextWithExcludedElements(this.element, options.exclude);

src/cdk/testing/text-filtering.ts

@@ -1,3 +1,8 @@
+/**
+ * Gets text of element excluding certain selectors within the element.
+ * @param element Element to get text from,
+ * @param excludeSelector Selector identifying which elements to exclude,
+ */
 export function getTextWithExcludedElements(element: Element, excludeSelector: string) {
   const clone = element.cloneNode(true) as Element;
   const exclusions = clone.querySelectorAll(excludeSelector);

tools/public_api_guard/cdk/testing.d.ts

@@ -131,9 +131,7 @@ export interface TestElement {
     sendKeys(...keys: (string | TestKey)[]): Promise<void>;
     sendKeys(modifiers: ModifierKeys, ...keys: (string | TestKey)[]): Promise<void>;
     setInputValue?(value: string): Promise<void>;
-    text(options?: {
-        exclude?: string;
-    }): Promise<string>;
+    text(options?: TextOptions): Promise<string>;
 }
 
 export declare enum TestKey {
@@ -168,3 +166,7 @@ export declare enum TestKey {
     F12 = 28,
     META = 29
 }
+
+export interface TextOptions {
+    exclude?: string;
+}

tools/public_api_guard/cdk/testing/protractor.d.ts

@@ -17,9 +17,7 @@ export declare class ProtractorElement implements TestElement {
     sendKeys(...keys: (string | TestKey)[]): Promise<void>;
     sendKeys(modifiers: ModifierKeys, ...keys: (string | TestKey)[]): Promise<void>;
     setInputValue(value: string): Promise<void>;
-    text(options?: {
-        exclude?: string;
-    }): Promise<string>;
+    text(options?: TextOptions): Promise<string>;
 }
 
 export declare class ProtractorHarnessEnvironment extends HarnessEnvironment<ElementFinder> {

tools/public_api_guard/cdk/testing/testbed.d.ts

@@ -34,7 +34,5 @@ export declare class UnitTestElement implements TestElement {
     sendKeys(...keys: (string | TestKey)[]): Promise<void>;
     sendKeys(modifiers: ModifierKeys, ...keys: (string | TestKey)[]): Promise<void>;
     setInputValue(value: string): Promise<void>;
-    text(options?: {
-        exclude?: string;
-    }): Promise<string>;
+    text(options?: TextOptions): Promise<string>;
 }