Interface FeatureIndexResults

Iterable Feature Index Results to iterate on feature rows

Hierarchy

IterableIterator<FeatureRow>
- FeatureIndexResults

Implemented by

Index

Methods

[iterator] close count ids next return? throw?

Methods

[iterator]

[iterator](): IterableIterator<FeatureRow>
Returns IterableIterator<FeatureRow>
Inherited from IterableIterator.__@iterator@65
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:55

close

close(): void
Close results

Returns void
- Defined in lib/features/index/featureIndexResults.ts:23

count

count(): number
Get the count of results

Returns
count

Returns number
- Defined in lib/features/index/featureIndexResults.ts:12

ids

ids(): IterableIterator<number>
Iterable for iterating over feature ids in place of feature rows

Returns
iterable ids

Returns IterableIterator<number>
- Defined in lib/features/index/featureIndexResults.ts:18

next

next(...args: [] | [undefined]): IteratorResult<FeatureRow, any>
Parameters
- Rest ...args: [] | [undefined]
Returns IteratorResult<FeatureRow, any>
Inherited from IterableIterator.next
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:45

`Optional` return

return(value?: any): IteratorResult<FeatureRow, any>
Parameters
- Optional value: any
Returns IteratorResult<FeatureRow, any>
Inherited from IterableIterator.return
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:46

`Optional` throw

throw(e?: any): IteratorResult<FeatureRow, any>
Parameters
- Optional e: any
Returns IteratorResult<FeatureRow, any>
Inherited from IterableIterator.throw
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:47

Generated using TypeDoc