sass-references/angular-material/material/form-field/testing/error-harness.ts

53 lines
1.7 KiB
TypeScript
Raw Permalink Normal View History

2024-12-06 10:42:08 +08:00
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.dev/license
*/
import {
BaseHarnessFilters,
ComponentHarness,
ComponentHarnessConstructor,
HarnessPredicate,
} from '@angular/cdk/testing';
/** A set of criteria that can be used to filter a list of error harness instances. */
export interface ErrorHarnessFilters extends BaseHarnessFilters {
/** Only find instances whose text matches the given value. */
text?: string | RegExp;
}
/** Harness for interacting with a `mat-error` in tests. */
export class MatErrorHarness extends ComponentHarness {
static hostSelector = '.mat-mdc-form-field-error';
/**
* Gets a `HarnessPredicate` that can be used to search for an error with specific
* attributes.
* @param options Options for filtering which error instances are considered a match.
* @return a `HarnessPredicate` configured with the given options.
*/
static with<T extends MatErrorHarness>(
this: ComponentHarnessConstructor<T>,
options: ErrorHarnessFilters = {},
): HarnessPredicate<T> {
return MatErrorHarness._getErrorPredicate(this, options);
}
protected static _getErrorPredicate<T extends MatErrorHarness>(
type: ComponentHarnessConstructor<T>,
options: ErrorHarnessFilters,
): HarnessPredicate<T> {
return new HarnessPredicate(type, options).addOption('text', options.text, (harness, text) =>
HarnessPredicate.stringMatches(harness.getText(), text),
);
}
/** Gets a promise for the error's label text. */
async getText(): Promise<string> {
return (await this.host()).text();
}
}