Skip to content

Commit 402dee9

Browse files
committed
docs: reword descriptions
1 parent 79527a9 commit 402dee9

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

projects/testing-library/src/lib/models.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,17 @@ export type RenderResultQueries<Q extends Queries = typeof queries> = { [P in ke
88
export interface RenderResult extends RenderResultQueries, FireObject, UserEvents {
99
/**
1010
* @description
11-
* The HTML of the rendered component
11+
* The containing DOM node of your rendered Angular Component.
12+
* This is a regular DOM node, so you can call container.querySelector etc. to inspect the children.
1213
*/
1314
container: HTMLElement;
1415
/**
1516
* @description
16-
* Prints out the component's HTML with syntax highlighting
17+
* Prints out the component's DOM with syntax highlighting.
18+
* Accepts an optional parameter, to print out a specific DOM node.
1719
*
1820
* @param
19-
* element: The to be printed HTML element, if not provided it will log the whole component's HTML
21+
* element: The to be printed HTML element, if not provided it will log the whole component's DOM
2022
*/
2123
debug: (element?: HTMLElement) => void;
2224
/**

projects/testing-library/src/lib/user-events/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import { createSelectOptions } from './selectOptions';
55
export interface UserEvents {
66
/**
77
* @description
8-
* Types a value in an input field just like the user would do
8+
* Types a value in an input field with the same interactions as the user would do.
99
*
1010
* @argument
1111
* element: HTMLElement - the form field to type in
12-
* value: string - the value to type in
12+
* value: string | number - the value to type in
1313
*
1414
* @example
1515
* component.type(component.getByLabelText('Firstname'), 'Tim')
@@ -20,7 +20,7 @@ export interface UserEvents {
2020

2121
/**
2222
* @description
23-
* Select an option(s) from a select just like the user would do
23+
* Select an option(s) from a select field with the same interactions as the user would do.
2424
*
2525
* @argument
2626
* element: HTMLElement - the select box to select an option in

projects/testing-library/src/lib/user-events/type.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ function wait(time) {
99
export interface TypeOptions {
1010
/**
1111
* @description
12-
* Write the text at once rather than on character at a time
12+
* Types the text at once rather than on character at a time
1313
*
1414
* @default
1515
* false

0 commit comments

Comments
 (0)