Heracles.ts

@hydra-cg/heracles.ts > FilterableCollectionIterator

Class: FilterableCollectionIterator

Provides an Iterator implementation for the FilterableCollection.

class:

Type parameters

T

Hierarchy

FilterableCollectionIterator

Implements

• Iterator<T>

Index

Constructors

• constructor

Properties

• filters
• items

Methods

• getNextMatchingItemFrom
• next
• equals
• isInArray
• matchesRegex

---

Constructors

constructor

⊕ new FilterableCollectionIterator(items: Iterable<T>, filters: IDictionary<any>): FilterableCollectionIterator

Defined in DataModel/Collections/FilterableCollectionIterator.ts:9

Initializes a new instance of the {@link FilterableCollectionIterator} class.

Parameters:

Name	Type	Description
items	Iterable<T>	Collection of items to iterate through.
filters	IDictionary<any>	Dictionary of predicate-value pairs used for filtering.

Returns: FilterableCollectionIterator

---

Properties

<Private> filters

● filters: IDictionary<any>

Defined in DataModel/Collections/FilterableCollectionIterator.ts:9

---

<Private> items

● items: Iterator<T>

Defined in DataModel/Collections/FilterableCollectionIterator.ts:8

---

Methods

<Private> getNextMatchingItemFrom

▸ getNextMatchingItemFrom(iterator: Iterator<T>): T

Defined in DataModel/Collections/FilterableCollectionIterator.ts:64

Parameters:

Name	Type
iterator	Iterator<T>

Returns: T

---

next

▸ next(): IteratorResult<T>

Defined in DataModel/Collections/FilterableCollectionIterator.ts:22

inheritdoc:

Returns: IteratorResult<T>

---

<Static><Private> equals

▸ equals(expectedValue: any, itemValue: any, predicate: any): boolean

Defined in DataModel/Collections/FilterableCollectionIterator.ts:53

Parameters:

Name	Type
expectedValue	any
itemValue	any
predicate	any

Returns: boolean

---

<Static><Private> isInArray

▸ isInArray(expectedValue: any, itemValue: any, predicate: any): boolean

Defined in DataModel/Collections/FilterableCollectionIterator.ts:31

Parameters:

Name	Type
expectedValue	any
itemValue	any
predicate	any

Returns: boolean

---

<Static><Private> matchesRegex

▸ matchesRegex(expectedValue: any, itemValue: any, predicate: any): boolean

Defined in DataModel/Collections/FilterableCollectionIterator.ts:48

Parameters:

Name	Type
expectedValue	any
itemValue	any
predicate	any

Returns: boolean

---

This site is open source. Improve this page.