OrderedSequenceImpl

Ordered sequence of elements

Type parameters

TItem

Hierarchy

SequenceImpl<TItem>
- OrderedSequenceImpl

Implements

Iterable<TItem>
Sequence<TItem>
OrderedSequence<TItem>

Index

Constructors

constructor

Methods

Constructors

constructor

new OrderedSequenceImpl(_iterableToSort: Iterable<TItem>, comparer: ComparerFn<TItem>): OrderedSequenceImpl

Overrides SequenceImpl.constructor
- Defined in Sequence.ts:355
Parameters
- _iterableToSort: Iterable<TItem>
- comparer: ComparerFn<TItem>
Returns OrderedSequenceImpl

Methods

__@iterator

__@iterator(): Iterator<TItem>

Implementation of OrderedSequence.__@iterator

Inherited from SequenceImpl.__@iterator
- Defined in Sequence.ts:51
Returns Iterator<TItem>

concat

concat<TOther>(...others: Iterable<TOther>[]): Sequence<TItem | TOther>

Implementation of OrderedSequence.concat

Inherited from SequenceImpl.concat
- Defined in Sequence.ts:53
Type parameters
- TOther
Parameters
- Rest ...others: Iterable<TOther>[]
Returns Sequence<TItem | TOther>

distinct

distinct(): Sequence<TItem>

Implementation of OrderedSequence.distinct

Inherited from SequenceImpl.distinct
- Defined in Sequence.ts:57
Returns Sequence<TItem>

every

every(predicate?: PredicateFn<TItem>): boolean

Implementation of OrderedSequence.every

Inherited from SequenceImpl.every
- Defined in Sequence.ts:61
Parameters
- Default value predicate: PredicateFn<TItem> = identityPredicateFn
Returns boolean

filter

filter(predicate: PredicateFn<TItem>): Sequence<TItem>

Implementation of OrderedSequence.filter

Inherited from SequenceImpl.filter
- Defined in Sequence.ts:71
Parameters
- predicate: PredicateFn<TItem>
Returns Sequence<TItem>

find

find(predicate: PredicateFn<TItem>): TItem | undefined

Implementation of OrderedSequence.find

Inherited from SequenceImpl.find
- Defined in Sequence.ts:75
Parameters
- predicate: PredicateFn<TItem>
Returns TItem | undefined

first

first(): TItem | undefined

Implementation of OrderedSequence.first

Inherited from SequenceImpl.first
- Defined in Sequence.ts:85
Returns TItem | undefined

flatMap

flatMap<TResultItem>(mapperFn: MapFn<TItem, TResultItem[]>): Sequence<TResultItem>

Implementation of OrderedSequence.flatMap

Inherited from SequenceImpl.flatMap
- Defined in Sequence.ts:93
Type parameters
- TResultItem
Parameters
- mapperFn: MapFn<TItem, TResultItem[]>
Returns Sequence<TResultItem>

forEach

forEach(callback: CallbackFn<TItem>): void

Implementation of OrderedSequence.forEach

Inherited from SequenceImpl.forEach
- Defined in Sequence.ts:99
Parameters
- callback: CallbackFn<TItem>
Returns void

groupBy

groupBy<TKey>(key: TKey): Sequence<Grouping<TItem[TKey], TItem>>
groupBy<TKey>(keySelector: KeySelectorFn<TItem, TKey>): Sequence<Grouping<TKey, TItem>>
groupBy<TKey, TElement>(key: TKey, elementSelector: MapFn<TItem, TElement>): Sequence<Grouping<TItem[TKey], TItem>>
groupBy<TKey, TElement>(keySelector: KeySelectorFn<TItem, TKey>, elementSelector: MapFn<TItem, TElement>): Sequence<Grouping<TKey, TElement>>

Implementation of OrderedSequence.groupBy

Inherited from SequenceImpl.groupBy
- Defined in Sequence.ts:105
Type parameters
- TKey: keyof TItem
Parameters
- key: TKey
Returns Sequence<Grouping<TItem[TKey], TItem>>
Implementation of OrderedSequence.groupBy

Inherited from SequenceImpl.groupBy
- Defined in Sequence.ts:108
Type parameters
- TKey
Parameters
- keySelector: KeySelectorFn<TItem, TKey>
Returns Sequence<Grouping<TKey, TItem>>
Implementation of OrderedSequence.groupBy

Inherited from SequenceImpl.groupBy
- Defined in Sequence.ts:111
Type parameters
- TKey: keyof TItem
- TElement
Parameters
- key: TKey
- elementSelector: MapFn<TItem, TElement>
Returns Sequence<Grouping<TItem[TKey], TItem>>
Implementation of OrderedSequence.groupBy

Inherited from SequenceImpl.groupBy
- Defined in Sequence.ts:115
Type parameters
- TKey
- TElement
Parameters
- keySelector: KeySelectorFn<TItem, TKey>
- elementSelector: MapFn<TItem, TElement>
Returns Sequence<Grouping<TKey, TElement>>

includes

includes(searchItem: TItem): boolean

Implementation of OrderedSequence.includes

Inherited from SequenceImpl.includes
- Defined in Sequence.ts:133
Parameters
- searchItem: TItem
Returns boolean

isEmpty

isEmpty(): boolean

Implementation of OrderedSequence.isEmpty

Inherited from SequenceImpl.isEmpty
- Defined in Sequence.ts:143
Returns boolean

last

last(): TItem | undefined

Implementation of OrderedSequence.last

Inherited from SequenceImpl.last
- Defined in Sequence.ts:147
Returns TItem | undefined

map

map<TResultItem>(mapFn: MapFn<TItem, TResultItem>): Sequence<TResultItem>

Implementation of OrderedSequence.map

Inherited from SequenceImpl.map
- Defined in Sequence.ts:153
Type parameters
- TResultItem
Parameters
- mapFn: MapFn<TItem, TResultItem>
Returns Sequence<TResultItem>

pick

pick<TKeys>(...keys: TKeys[]): Sequence<object>

Implementation of OrderedSequence.pick

Inherited from SequenceImpl.pick
- Defined in Sequence.ts:157
Type parameters
- TKeys: keyof TItem
Parameters
- Rest ...keys: TKeys[]
Returns Sequence<object>

prepend

prepend(...items: Iterable<TItem>[]): Sequence<TItem>

Implementation of OrderedSequence.prepend

Inherited from SequenceImpl.prepend
- Defined in Sequence.ts:173
Parameters
- Rest ...items: Iterable<TItem>[]
Returns Sequence<TItem>

reduce

reduce<TResult>(callback: ReduceCallbackFn<TResult, TItem>, accumulator: TResult): TResult

Implementation of OrderedSequence.reduce

Inherited from SequenceImpl.reduce
- Defined in Sequence.ts:177
Type parameters
- TResult
Parameters
- callback: ReduceCallbackFn<TResult, TItem>
- accumulator: TResult
Returns TResult

reverse

reverse(): Sequence<TItem>

Implementation of OrderedSequence.reverse

Inherited from SequenceImpl.reverse
- Defined in Sequence.ts:188
Returns Sequence<TItem>

skip

skip(howMany: number): Sequence<TItem>

Implementation of OrderedSequence.skip

Inherited from SequenceImpl.skip
- Defined in Sequence.ts:192
Parameters
- howMany: number
Returns Sequence<TItem>

skipWhile

skipWhile(predicate: PredicateFn<TItem>): Sequence<TItem>

Implementation of OrderedSequence.skipWhile

Inherited from SequenceImpl.skipWhile
- Defined in Sequence.ts:196
Parameters
- predicate: PredicateFn<TItem>
Returns Sequence<TItem>

some

some(predicate?: PredicateFn<TItem>): boolean

Implementation of OrderedSequence.some

Inherited from SequenceImpl.some
- Defined in Sequence.ts:200
Parameters
- Default value predicate: PredicateFn<TItem> = identityPredicateFn
Returns boolean

sortBy

sortBy(): OrderedSequence<TItem>
sortBy<TKey>(keySelector: KeySelectorFn<TItem, TKey>, comparer?: ComparerFn<TKey>): OrderedSequence<TItem>

Implementation of OrderedSequence.sortBy

Inherited from SequenceImpl.sortBy
- Defined in Sequence.ts:209
Returns OrderedSequence<TItem>
Implementation of OrderedSequence.sortBy

Inherited from SequenceImpl.sortBy
- Defined in Sequence.ts:210
Type parameters
- TKey
Parameters
- keySelector: KeySelectorFn<TItem, TKey>
- Optional comparer: ComparerFn<TKey>
Returns OrderedSequence<TItem>

sortByDescending

sortByDescending<TKey>(keySelector?: KeySelectorFn<TItem, TKey>, comparer?: ComparerFn<TKey>): OrderedSequence<TItem>

Implementation of OrderedSequence.sortByDescending

Inherited from SequenceImpl.sortByDescending
- Defined in Sequence.ts:223
Type parameters
- TKey
Parameters
- Optional keySelector: KeySelectorFn<TItem, TKey>
- Optional comparer: ComparerFn<TKey>
Returns OrderedSequence<TItem>

sum

sum<TItem>(): number
sum<TItem>(): string
sum<TResult>(valueSelector: MapFn<TItem, TResult>): number
sum<TResult>(valueSelector: MapFn<TItem, TResult>): string

Implementation of OrderedSequence.sum

Inherited from SequenceImpl.sum
- Defined in Sequence.ts:232
Type parameters
- TItem: number
Returns number
Implementation of OrderedSequence.sum

Inherited from SequenceImpl.sum
- Defined in Sequence.ts:233
Type parameters
- TItem: string
Returns string
Implementation of OrderedSequence.sum

Inherited from SequenceImpl.sum
- Defined in Sequence.ts:234
Type parameters
- TResult: number
Parameters
- valueSelector: MapFn<TItem, TResult>
Returns number
Implementation of OrderedSequence.sum

Inherited from SequenceImpl.sum
- Defined in Sequence.ts:235
Type parameters
- TResult: string
Parameters
- valueSelector: MapFn<TItem, TResult>
Returns string

take

take(howMany: number): Sequence<TItem>

Implementation of OrderedSequence.take

Inherited from SequenceImpl.take
- Defined in Sequence.ts:255
Parameters
- howMany: number
Returns Sequence<TItem>

takeWhile

takeWhile(predicate: PredicateFn<TItem>): SequenceImpl<TItem>

Implementation of OrderedSequence.takeWhile

Inherited from SequenceImpl.takeWhile
- Defined in Sequence.ts:259
Parameters
- predicate: PredicateFn<TItem>
Returns SequenceImpl<TItem>

thenBy

thenBy<TOtherKey>(keySelector: KeySelectorFn<TItem, TOtherKey>, comparer?: ComparerFn<TOtherKey>): OrderedSequence<TItem>

Implementation of OrderedSequence.thenBy
- Defined in Sequence.ts:366
Type parameters
- TOtherKey
Parameters
- keySelector: KeySelectorFn<TItem, TOtherKey>
- Optional comparer: ComparerFn<TOtherKey>
Returns OrderedSequence<TItem>

thenByDescending

thenByDescending<TOtherKey>(keySelector: KeySelectorFn<TItem, TOtherKey>, comparer?: ComparerFn<TOtherKey>): OrderedSequence<TItem>

Implementation of OrderedSequence.thenByDescending
- Defined in Sequence.ts:376
Type parameters
- TOtherKey
Parameters
- keySelector: KeySelectorFn<TItem, TOtherKey>
- Optional comparer: ComparerFn<TOtherKey>
Returns OrderedSequence<TItem>

toArray

toArray(): TItem[]

Implementation of OrderedSequence.toArray

Inherited from SequenceImpl.toArray
- Defined in Sequence.ts:275
Returns TItem[]

toMap

toMap<TKey, TElement>(keySelectorFn: MapFn<TItem, TKey>, elementSelectorFn?: MapFn<TItem, TElement>): Map<TKey, TElement>

Implementation of OrderedSequence.toMap

Inherited from SequenceImpl.toMap
- Defined in Sequence.ts:279
Type parameters
- TKey
- TElement
Parameters
- keySelectorFn: MapFn<TItem, TKey>
- Optional elementSelectorFn: MapFn<TItem, TElement>
Returns Map<TKey, TElement>

toObject

toObject(keySelectorFn: MapFn<TItem, string>): StringKeyedObject<TItem>
toObject(keySelectorFn: MapFn<TItem, number>): NumberKeyedObject<TItem>
toObject<TElement>(keySelectorFn: MapFn<TItem, string>, elementSelectorFn: MapFn<TItem, TElement>): StringKeyedObject<TElement>
toObject<TElement>(keySelectorFn: MapFn<TItem, number>, elementSelectorFn: MapFn<TItem, TElement>): NumberKeyedObject<TElement>

Implementation of OrderedSequence.toObject

Inherited from SequenceImpl.toObject
- Defined in Sequence.ts:295
Parameters
- keySelectorFn: MapFn<TItem, string>
Returns StringKeyedObject<TItem>
Implementation of OrderedSequence.toObject

Inherited from SequenceImpl.toObject
- Defined in Sequence.ts:296
Parameters
- keySelectorFn: MapFn<TItem, number>
Returns NumberKeyedObject<TItem>
Implementation of OrderedSequence.toObject

Inherited from SequenceImpl.toObject
- Defined in Sequence.ts:297
Type parameters
- TElement
Parameters
- keySelectorFn: MapFn<TItem, string>
- elementSelectorFn: MapFn<TItem, TElement>
Returns StringKeyedObject<TElement>
Implementation of OrderedSequence.toObject

Inherited from SequenceImpl.toObject
- Defined in Sequence.ts:301
Type parameters
- TElement
Parameters
- keySelectorFn: MapFn<TItem, number>
- elementSelectorFn: MapFn<TItem, TElement>
Returns NumberKeyedObject<TElement>

toSet

toSet(): Set<TItem>

Implementation of OrderedSequence.toSet

Inherited from SequenceImpl.toSet
- Defined in Sequence.ts:325
Returns Set<TItem>

toString

toString(separator?: string): string

Inherited from SequenceImpl.toString
- Defined in Sequence.ts:329
Parameters
- Default value separator: string = ","
Returns string

without

without(items: Iterable<TItem>, predicate?: ComparePredicate<TItem>): Sequence<TItem>

Implementation of OrderedSequence.without

Inherited from SequenceImpl.without
- Defined in Sequence.ts:263
Parameters
- items: Iterable<TItem>
- Optional predicate: ComparePredicate<TItem>
Returns Sequence<TItem>

Generated using TypeDoc

Type parameters

TItem

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

_iterableToSort: Iterable<TItem>

comparer: ComparerFn<TItem>

Returns OrderedSequenceImpl

Methods

__@iterator

Returns Iterator<TItem>

concat

Type parameters

TOther

Parameters

Rest ...others: Iterable<TOther>[]

Returns Sequence<TItem | TOther>

distinct

Returns Sequence<TItem>

every

Parameters

Default value predicate: PredicateFn<TItem> = identityPredicateFn

Returns boolean

filter

Parameters

predicate: PredicateFn<TItem>

Returns Sequence<TItem>

find

Parameters

predicate: PredicateFn<TItem>

Returns TItem | undefined

first

Returns TItem | undefined

flatMap

Type parameters

TResultItem

Parameters

mapperFn: MapFn<TItem, TResultItem[]>

Returns Sequence<TResultItem>

forEach

Parameters

callback: CallbackFn<TItem>

Returns void

groupBy

Type parameters

TKey: keyof TItem

Parameters

key: TKey

Returns Sequence<Grouping<TItem[TKey], TItem>>

Type parameters

TKey

Parameters

keySelector: KeySelectorFn<TItem, TKey>

Returns Sequence<Grouping<TKey, TItem>>

Type parameters

TKey: keyof TItem

TElement

Parameters

key: TKey

elementSelector: MapFn<TItem, TElement>

Returns Sequence<Grouping<TItem[TKey], TItem>>

Type parameters

TKey

TElement

Parameters

keySelector: KeySelectorFn<TItem, TKey>

elementSelector: MapFn<TItem, TElement>

Returns Sequence<Grouping<TKey, TElement>>

includes

Parameters

searchItem: TItem

Returns boolean

isEmpty

Returns boolean

last