FilterUniqueIterator | plannerjs

An AsyncIterator that emits only the unique items emitted by a source iterator.

Uniqueness is determined by a comparator callback function

Note: All (unique) items get stored in an array internally

Type parameters

Hierarchy

SimpleTransformIterator<T, T>
- FilterUniqueIterator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FilterUniqueIterator(source: AsyncIterator<T>, comparator: function): FilterUniqueIterator

Overrides SimpleTransformIterator.constructor
- Defined in src/util/iterators/FilterUniqueIterator.ts:13
Parameters
- source: AsyncIterator<T>
- comparator: function
  - - (object: T, otherObject: T): boolean
    - Parameters
      - object: T
      - otherObject: T
      Returns boolean
Returns FilterUniqueIterator

Properties

Optional _appender

_appender: ArrayIterator<T>

_buffer

_buffer: T[]

Optional _destination

_destination: AsyncIterator<any>

_limit

_limit: number

_offset

_offset: number

_optional

_optional: boolean

Optional _prepender

_prepender: ArrayIterator<T>

_pushedCount

_pushedCount: number

_readable

_readable: boolean

_state

_state: number

closed

closed: boolean

ended

ended: boolean

maxBufferSize

maxBufferSize: number

readable

readable: boolean

source

source: AsyncIterator<T>

Static CLOSED

CLOSED: 3

Static CLOSING

CLOSING: 2

Static ENDED

ENDED: 4

Static INIT

INIT: 0

Static OPEN

OPEN: 1

Static STATES

STATES: ["INIT", "OPEN", "CLOSING", "CLOSED", "ENDED"]

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_begin

_begin(done: function): void

Inherited from BufferedIterator._begin
- Defined in src/asynciterator.d.ts:117
Parameters
- done: function
  - - (): void
    - Returns void
Returns void

_changeState

_changeState(newState: number, eventAsync?: boolean): void

Inherited from AsyncIterator._changeState
- Defined in src/asynciterator.d.ts:33
Parameters
- newState: number
- Optional eventAsync: boolean
Returns void

_closeWhenDone

_closeWhenDone(): void

Inherited from TransformIterator._closeWhenDone
- Defined in src/asynciterator.d.ts:146
Returns void

_completeClose

_completeClose(): void

Inherited from BufferedIterator._completeClose
- Defined in src/asynciterator.d.ts:125
Returns void

_end

_end(): void

Inherited from AsyncIterator._end
- Defined in src/asynciterator.d.ts:40
Returns void

_fillBuffer

_fillBuffer(): void

Inherited from BufferedIterator._fillBuffer
- Defined in src/asynciterator.d.ts:123
Returns void

_filter

_filter(object: T): boolean

Overrides SimpleTransformIterator._filter
- Defined in src/util/iterators/FilterUniqueIterator.ts:25
Parameters
- object: T
Returns boolean

_flush

_flush(done: function): void

Inherited from BufferedIterator._flush
- Defined in src/asynciterator.d.ts:127
Parameters
- done: function
  - - (): void
    - Returns void
Returns void

_init

_init(autoStart: boolean): void

Inherited from BufferedIterator._init
- Defined in src/asynciterator.d.ts:115
Parameters
- autoStart: boolean
Returns void

_insert

_insert(inserter: AsyncIterator<T>, done: function): void

Inherited from SimpleTransformIterator._insert
- Defined in src/asynciterator.d.ts:176
Parameters
- inserter: AsyncIterator<T>
- done: function
  - - (): void
    - Returns void
Returns void

Optional _map

_map(item: T): T

Inherited from SimpleTransformIterator._map
- Defined in src/asynciterator.d.ts:172
Parameters
- item: T
Returns T

_push

_push(item: T): void

Inherited from BufferedIterator._push
- Defined in src/asynciterator.d.ts:121
Parameters
- item: T
Returns void

_read

_read(count: number, done: function): void

Inherited from BufferedIterator._read
- Defined in src/asynciterator.d.ts:119
Parameters
- count: number
- done: function
  - - (): void
    - Returns void
Returns void

_toStringDetails

_toStringDetails(): string

Inherited from AsyncIterator._toStringDetails
- Defined in src/asynciterator.d.ts:54
Returns string

_transform

_transform(item: T, done: function): void

Inherited from SimpleTransformIterator._transform

Overrides TransformIterator._transform
- Defined in src/asynciterator.d.ts:174
Parameters
- item: T
- done: function
  - - (result: T): void
    - Parameters
      - result: T
      Returns void
Returns void

_validateSource

_validateSource(source: AsyncIterator<T>, allowDestination?: boolean): void

Inherited from TransformIterator._validateSource
- Defined in src/asynciterator.d.ts:142
Parameters
- source: AsyncIterator<T>
- Optional allowDestination: boolean
Returns void

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:32
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

append

append<T>(items: T[] | AsyncIterator<T>): SimpleTransformIterator<T, T>

Inherited from AsyncIterator.append
- Defined in src/asynciterator.d.ts:64
Type parameters
- T
Parameters
- items: T[] | AsyncIterator<T>
Returns SimpleTransformIterator<T, T>

clone

clone(): ClonedIterator<T>

Inherited from AsyncIterator.clone
- Defined in src/asynciterator.d.ts:74
Returns ClonedIterator<T>

close

close(): void

Inherited from AsyncIterator.close
- Defined in src/asynciterator.d.ts:31
Returns void

copyProperties

copyProperties(source: AsyncIterator<any>, propertyNames: string[]): void

Inherited from AsyncIterator.copyProperties
- Defined in src/asynciterator.d.ts:50
Parameters
- source: AsyncIterator<any>
- propertyNames: string[]
Returns void

each

each(callback: function, self?: any): void

Inherited from AsyncIterator.each
- Defined in src/asynciterator.d.ts:29
Parameters
- callback: function
  - - (data: T): void
    - Parameters
      - data: T
      Returns void
- Optional self: any
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:44
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:45
Returns Array<string | symbol>

filter

filter(filter: function, self?: object): SimpleTransformIterator<T, T>

Inherited from AsyncIterator.filter
- Defined in src/asynciterator.d.ts:60
Parameters
- filter: function
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
- Optional self: object
Returns SimpleTransformIterator<T, T>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:41
Returns number

getProperties

getProperties(): object

Inherited from AsyncIterator.getProperties
- Defined in src/asynciterator.d.ts:46
Returns object
- [id: string]: any

getProperty

getProperty(propertyName: string, callback?: function): any

Inherited from AsyncIterator.getProperty
- Defined in src/asynciterator.d.ts:42
Parameters
- propertyName: string
- Optional callback: function
  - - (value: any): void
    - Parameters
      - value: any
      Returns void
Returns any

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:46
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:42
Parameters
- event: string | symbol
Returns Function[]

map

map<T2>(mapper: function, self?: object): SimpleTransformIterator<T, T2>

Inherited from AsyncIterator.map
- Defined in src/asynciterator.d.ts:58
Type parameters
- T2
Parameters
- mapper: function
  - - (item: T): T2
    - Parameters
      - item: T
      Returns T2
- Optional self: object
Returns SimpleTransformIterator<T, T2>

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:38
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:33
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:34
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prepend

prepend(items: T[] | AsyncIterator<T>): SimpleTransformIterator<T, T>

Inherited from AsyncIterator.prepend
- Defined in src/asynciterator.d.ts:62
Parameters
- items: T[] | AsyncIterator<T>
Returns SimpleTransformIterator<T, T>

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:35
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:36
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

range

range<T>(start: number, end: number): SimpleTransformIterator<T, T>

Inherited from AsyncIterator.range
- Defined in src/asynciterator.d.ts:72
Type parameters
- T
Parameters
- start: number
- end: number
Returns SimpleTransformIterator<T, T>

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:43
Parameters
- event: string | symbol
Returns Function[]

read

read(): T

Inherited from AsyncIterator.read
- Defined in src/asynciterator.d.ts:27
Returns T

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:39
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:37
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:40
Parameters
- n: number
Returns this

setProperties

setProperties(properties: object): void

Inherited from AsyncIterator.setProperties
- Defined in src/asynciterator.d.ts:48
Parameters
- properties: object
  - [id: string]: any
Returns void

setProperty

setProperty(propertyName: string, value: any): void

Inherited from AsyncIterator.setProperty
- Defined in src/asynciterator.d.ts:44
Parameters
- propertyName: string
- value: any
Returns void

skip

skip<T>(offset: number): SimpleTransformIterator<T, T>

Inherited from AsyncIterator.skip
- Defined in src/asynciterator.d.ts:68
Type parameters
- T
Parameters
- offset: number
Returns SimpleTransformIterator<T, T>

surround

surround<T>(prepend: T[] | AsyncIterator<T>, append: T[] | AsyncIterator<T>): SimpleTransformIterator<T, T>

Inherited from AsyncIterator.surround
- Defined in src/asynciterator.d.ts:66
Type parameters
- T
Parameters
- prepend: T[] | AsyncIterator<T>
- append: T[] | AsyncIterator<T>
Returns SimpleTransformIterator<T, T>

take

take<T>(limit: number): SimpleTransformIterator<T, T>

Inherited from AsyncIterator.take
- Defined in src/asynciterator.d.ts:70
Type parameters
- T
Parameters
- limit: number
Returns SimpleTransformIterator<T, T>

toString

toString(): string

Inherited from AsyncIterator.toString
- Defined in src/asynciterator.d.ts:52
Returns string

transform

transform<T2>(options?: SimpleTransformIteratorOptions<T, T2>): SimpleTransformIterator<T, T2>

Inherited from AsyncIterator.transform
- Defined in src/asynciterator.d.ts:56
Type parameters
- T2
Parameters
- Optional options: SimpleTransformIteratorOptions<T, T2>
Returns SimpleTransformIterator<T, T2>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:29
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static range

range(start?: number, end?: number, step?: number): IntegerIterator

Inherited from AsyncIterator.range
- Defined in src/asynciterator.d.ts:76
Parameters
- Optional start: number
- Optional end: number
- Optional step: number
Returns IntegerIterator

Generated using TypeDoc

Type parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

source: AsyncIterator<T>

comparator: function

Parameters

object: T

otherObject: T

Returns boolean

Returns FilterUniqueIterator

Properties

Optional _appender

_buffer

Optional _destination

_limit

_offset

_optional

Optional _prepender

_pushedCount

_readable

_state

closed

ended

maxBufferSize

readable

source

Static CLOSED

Static CLOSING

Static ENDED

Static INIT

Static OPEN

Static STATES

Static defaultMaxListeners

Methods

_begin

Parameters

done: function

Returns void

Returns void

_changeState

Parameters

newState: number

Optional eventAsync: boolean

Returns void

_closeWhenDone

Returns void

_completeClose

Returns void

_end

Returns void

_fillBuffer

Returns void

_filter

Parameters

object: T

Returns boolean

_flush

Parameters

done: function

Returns void

Returns void

_init

Parameters

autoStart: boolean

Returns void

_insert

Parameters

inserter: AsyncIterator<T>

done: function

Returns void

Returns void

Optional _map

Parameters