goog.dom.iter.SiblingIterator

Provided By	`goog.dom.iter.SiblingIterator`
Extends	`goog.iter.Iterator`
All Implemented Interfaces	`Iterator<?, ?, ?>`
All Known Direct Subclasses	`goog.dom.iter.ChildIterator`

Iterator over a Node's siblings.

Parameters

`node`	`(Node\|null)`
	The node to start with.
`opt_includeNode`	`boolean=`
	Whether to return the given node as the first return value from next.
`opt_reverse`	`boolean=`
	Whether to traverse siblings in reverse document order.

Instance Methods

Returns the Iterator object itself. This is used to implement the iterator protocol in JavaScript 1.7

Defined by

Parameters

`opt_keys`	`boolean=`
	Whether to return the keys or values. Default is to only return the values. This is being used by the for-in loop (true) and the for-each-in loop (false). Even though the param gives a hint about what the iterator will return there is no guarantee that it will return the keys when true is passed.

Returns

goog.iter.Iterator<(VALUE|null)>

The object itself.

Returns the next value of the iteration as an an ES6 IIterableResult.

Overrides

Specified by

Parameters

`opt_value`	`?=`

Returns

IIterableResult<Node>