API reference docs for HTML reporter and spec filters

This commit is contained in:
Steve Gravrock
2025-09-17 07:30:34 -07:00
parent 8309416cb2
commit fa481b2bd1
4 changed files with 90 additions and 0 deletions

View File

@@ -1,4 +1,13 @@
jasmineRequire.HtmlSpecFilter = function() {
/**
* @name HtmlSpecFilter
* @classdesc Legacy HTML spec filter, for backward compatibility
* with boot files that predate {@link HtmlExactSpecFilter}.
* @param options Object with a filterString method
* @constructor
* @deprecated
* @since 1.2.0
*/
// Legacy HTML spec filter, preserved for backward compatibility with
// boot files that predate HtmlExactSpecFilterV2
function HtmlSpecFilter(options) {
@@ -13,6 +22,13 @@ jasmineRequire.HtmlSpecFilter = function() {
const filterPattern = new RegExp(filterString);
/**
* Determines whether the spec with the specified name should be executed.
* @name HtmlSpecFilter#matches
* @function
* @param {string} specName The full name of the spec
* @returns {boolean}
*/
this.matches = function(specName) {
return filterPattern.test(specName);
};