NGX CSS - Angular Components Squid Style
  1. Miscellaneous
  2. Functions

Index

src/helpers/testing-spec.helper.ts

checkField
checkField(fixture: ComponentFixture, testId: string, checked: boolean)

Checks or unchecks a checkbox or radio button. Triggers appropriate events so Angular takes notice of the change.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
testId string No

Test id set by data-testid
checked boolean No

Whether the checkbox or radio should be checked
Returns : void
click
click(fixture: ComponentFixture, testId: string)

Emulates a left click on the element with the given data-testid attribute.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
testId string No

Test id set by data-testid
Returns : void
dispatchFakeEvent
dispatchFakeEvent(element: EventTarget, type: string, bubbles)

Dispatches a fake event (synthetic event) at the given element.

Parameters :
Name Type Optional Default value Description
element EventTarget No

Element that is the target of the event
type string No

Event name, e.g. input
bubbles No false

Whether the event bubbles up in the DOM tree
Returns : void
expectContainedText
expectContainedText(fixture: ComponentFixture, text: string)

Expects that the element with the given data-testid attribute has the given text content.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
text string No

Expected text
Returns : void
expectContent
expectContent(fixture: ComponentFixture, text: string)

Expects that a component has the given text content. Both the component text content and the expected text are trimmed for reliability.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
text string No

Expected text
Returns : void
expectText
expectText(fixture: ComponentFixture, testId: string, text: string)

Expects that the element with the given data-testid attribute has the given text content.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
testId string No

Test id set by data-testid
text string No

Expected text
Returns : void
findComponent
findComponent(fixture: ComponentFixture, selector: string)

Finds a nested Component by its selector, e.g. app-example. Throws an error if no element was found. Use this only for shallow component testing. When finding other elements, use findEl / findEls and data-testid attributes.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Fixture of the parent Component
selector string No

Element selector, e.g. app-example
Returns : DebugElement
findComponents
findComponents(fixture: ComponentFixture, selector: string)

Finds all nested Components by its selector, e.g. app-example.

Parameters :
Name Type Optional
fixture ComponentFixture No
selector string No
Returns : DebugElement[]
findEl
findEl(fixture: ComponentFixture, testId: string)

Finds an element inside the Component by the given data-testid attribute. Throws an error if no element was found.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
testId string No

Test id set by data-testid
Returns : DebugElement
findEls
findEls(fixture: ComponentFixture, testId: string)

Finds all elements with the given data-testid attribute.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
testId string No

Test id set by data-testid
Returns : DebugElement[]
getText
getText(fixture: ComponentFixture, testId: string)

Gets the text content of an element with the given data-testid attribute.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
testId string No

Test id set by data-testid
Returns : string
makeClickEvent
makeClickEvent(target: EventTarget)

Makes a fake click event that provides the most important properties. Sets the button to left. The event can be passed to DebugElement#triggerEventHandler.

Parameters :
Name Type Optional Description
target EventTarget No

Element that is the target of the click event
Returns : Partial<MouseEvent>
queryByCss
queryByCss(fixture: ComponentFixture, selector: string)

Finds a single element inside the Component by the given CSS selector. Throws an error if no element was found.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
selector string No

CSS selector
Returns : DebugElement
setFieldElementValue
setFieldElementValue(element, value: string)

Enters text into a form field (input, textarea or select element). Triggers appropriate events so Angular takes notice of the change. If you listen for the change event on input or textarea, you need to trigger it separately.

Parameters :
Name Type Optional Description
element No

Form field
value string No

Form field value
Returns : void
setFieldValue
setFieldValue(fixture: ComponentFixture, testId: string, value: string)

Sets the value of a form field with the given data-testid attribute.

Parameters :
Name Type Optional Description
fixture ComponentFixture No

Component fixture
testId string No

Test id set by data-testid
value string No

Form field value
Returns : void
testIdSelector
testIdSelector(testId: string)

Returns a selector for the data-testid attribute with the given attribute value.

Parameters :
Name Type Optional Description
testId string No

Test id set by data-testid
Returns : string

src/interfaces/modal.interface.ts

confirmBeforeClose
confirmBeforeClose(guard: BeforeCloseGuard)

RxJS operator to add a confirmation guard before closing a dialog. The guard is only called when closing without a result (cancel/close button).

Parameters :
Name Type Optional Description
guard BeforeCloseGuard No
  • Function that returns whether to proceed with closing
Returns : OperatorFunction<R | undefined, R | undefined>

src/helpers/formatTime.helper.ts

formatTime
formatTime(totalSeconds: number)

Format time in seconds to a readable format.

Parameters :
Name Type Optional Description
totalSeconds number No
  • Time in seconds
Returns : string

A string that contains the formatted time

src/helpers/sleep.helper.ts

sleep
sleep(ms: number)

Sleeps for a specified number of milliseconds.

Parameters :
Name Type Optional Default value
ms number No 300
Returns : Promise<void>

A Promise that resolves after the specified delay.

src/helpers/memo.helper.ts

useMemo
useMemo(fnToMemoize: T)

Memoizes a function by caching its result based on the input arguments.

This utility function takes a function fnToMemoize and returns a memoized version of it. The memoized function will cache its result based on the input arguments. If the same set of arguments is passed again, the cached result will be returned without re-executing the function.

Parameters :
Name Type Optional Description
fnToMemoize T No
  • The function to memoize. It can take any number of arguments and return any value.
Returns : T
  • A memoized version of the input function.

results matching ""

    No results matching ""