Matcher

Creates new instance of Matcher.

Parameters

pattern : Array<MatcherPattern>

Match patterns. See add method for more information.

Adds pattern or patterns to matcher instance.

// String.
matcher.add( 'div' );

// Regular expression.
matcher.add( /^\w/ );

// Single class.
matcher.add( {
	classes: 'foobar'
} );

See MatcherPattern for more examples.

Multiple patterns can be added in one call:

matcher.add( 'div', { classes: 'foobar' } );

Parameters

pattern : Array<MatcherPattern>

Object describing pattern details. If string or regular expression is provided it will be used to match element's name. Pattern can be also provided in a form of a function - then this function will be called with each element as a parameter. Function's return value will be stored under match key of the object returned from match or matchAll methods.

Returns

void

Returns the name of the element to match if there is exactly one pattern added to the matcher instance and it matches element name defined by string (not RegExp). Otherwise, returns null.

Returns

null | string

Element name trying to match.

Matches elements for currently stored patterns. Returns match information about first found element, otherwise returns null.

Example of returned object:

{
	element: <instance of found element>,
	pattern: <pattern used to match found element>,
	match: {
		name: true,
		attributes: [
			[ 'title' ],
			[ 'href' ],
			[ 'class', 'foo' ],
			[ 'style', 'color' ],
			[ 'style', 'position' ]
		]
	}
}

You could use the match field from the above returned object as an input for the ViewConsumable#test() and ViewConsumable#consume() methods.

Parameters

element : Array<ViewElement>

View element to match against stored patterns.

Returns

null | MatchResult

The match information about found element or null.

Related:

• Matcher#add
• Matcher#matchAll

Matches elements for currently stored patterns. Returns array of match information with all found elements. If no element is found - returns null.

Parameters

element : Array<ViewElement>

View element to match against stored patterns.

Returns

null | Array<MatchResult>

Array with match information about found elements or null. For more information see match method description.

Related:

• Matcher#add
• Matcher#match

Returns match information if element is matching provided pattern. If element cannot be matched to provided pattern - returns null.

Parameters

element : ViewElement

pattern : MatcherFunctionPattern | MatcherObjectPattern

Returns

null | Match

Returns object with match information or null if element is not matching.