Class Alot<T>

Type Parameters

T = any

Hierarchy

AlotProto<T>
- Alot

Constructors

constructor

new Alot<T>(array, meta?): Alot<T>
Type Parameters
- T = any
Parameters
- array: T[]
- Optionalmeta: AlotMeta
Returns Alot<T>
Overrides AlotProto<T>.constructor
- Defined in alot.ts:9

Properties

array

array: T[]

isAsync

isAsync: boolean = false

`Optional`meta

meta?: AlotMeta

stream

stream: IAlotStream<T>

Methods

[iterator]

[iterator](): Alot<T>
Returns Alot<T>
Inherited from AlotProto.[iterator]
- Defined in AlotProto.ts:57

concat

concat<TSourceB>(arr): ConcatStream<T, TSourceB>
Type Parameters
- TSourceB
Parameters
- arr: TSourceB[]
Returns ConcatStream<T, TSourceB>
Inherited from AlotProto.concat
- Defined in AlotProto.ts:150

distinct

distinct(): DistinctByStream<T, string | number>
Returns DistinctByStream<T, string | number>
Inherited from AlotProto.distinct
- Defined in AlotProto.ts:158

distinctBy

distinctBy(fn): DistinctByStream<T, string | number>
Parameters
- fn: DistinctByKeyFn<T>
Returns DistinctByStream<T, string | number>
Inherited from AlotProto.distinctBy
- Defined in AlotProto.ts:155

filter

filter(fn): FilterStream<T>
Creates filtered stream. Is Lazy.
```
alot(users).filter(x => x.age > 20).take(3).toArray();
```
Filter is evaluated only N times, to match only 3 items.
Parameters
- fn: MethodFilter<T>
Returns FilterStream<T>
Inherited from AlotProto.filter
- Defined in AlotProto.ts:75

filterAsync

filterAsync(fn): FilterStreamAsync<T>
Creates async filted stream. Same as filter, but accepts async methods, and returns awaitable stream.
Parameters
- fn: MethodFilter<T>
Returns FilterStreamAsync<T>
Inherited from AlotProto.filterAsync
- Defined in AlotProto.ts:81

find

find(matcher?): T
Parameters
- Optionalmatcher: ((x: T, i?: number) => boolean)
  - - (x, i?): boolean
    - Parameters
      x: T
      Optionali: number
      Returns boolean
Returns T
Inherited from AlotProto.find
- Defined in AlotProto.ts:300

findAsync

findAsync(matcher?): Promise<T>
Parameters
- Optionalmatcher: ((x: T, i?: number) => boolean | Promise<boolean>)
  - - (x, i?): boolean | Promise<boolean>
    - Parameters
      x: T
      Optionali: number
      Returns boolean | Promise<boolean>
Returns Promise<T>
Inherited from AlotProto.findAsync
- Defined in AlotProto.ts:303

first

first(matcher?): T
Parameters
- Optionalmatcher: ((x: T, i?: number) => boolean)
  - - (x, i?): boolean
    - Parameters
      x: T
      Optionali: number
      Returns boolean
Returns T
Inherited from AlotProto.first
- Defined in AlotProto.ts:265

firstAsync

firstAsync(matcher?): Promise<T>
Parameters
- Optionalmatcher: ((x: T, i?: number) => boolean | Promise<boolean>)
  - - (x, i?): boolean | Promise<boolean>
    - Parameters
      x: T
      Optionali: number
      Returns boolean | Promise<boolean>
Returns Promise<T>
Inherited from AlotProto.firstAsync
- Defined in AlotProto.ts:280

forEach

forEach(fn): ForEachStream<T>
Parameters
- fn: ForEachMethod<T>
Returns ForEachStream<T>
Inherited from AlotProto.forEach
- Defined in AlotProto.ts:104

forEachAsync

forEachAsync<TResult>(fn): ForEachStream<T>
Type Parameters
- TResult
Parameters
- fn: ForEachMethod<T>
Returns ForEachStream<T>
Inherited from AlotProto.forEachAsync
- Defined in AlotProto.ts:107

fork

fork(fn): this
Parameters
- fn: ((stream: this) => any)
  - - (stream): any
    - Parameters
      stream: this
      Returns any
Returns this
Inherited from AlotProto.fork
- Defined in AlotProto.ts:178

groupBy

groupBy<TKey>(fn): GroupByStream<T, TKey>
Type Parameters
- TKey = string
Parameters
- fn: GroupByKeyFn<T, TKey>
Returns GroupByStream<T, TKey>
Inherited from AlotProto.groupBy
- Defined in AlotProto.ts:128

join

join<TInner, TResult>(inner, getKey, getForeignKey, joinFn): JoinStream<T, TInner, TResult>
Join Left Inner
Type Parameters
- TInner = T
- TResult = T
Parameters
- inner: TInner[]
- getKey: ((x: T) => string | number)
  - - (x): string | number
    - Parameters
      x: T
      Returns string | number
- getForeignKey: ((x: TInner) => string | number)
  - - (x): string | number
    - Parameters
      x: TInner
      Returns string | number
- joinFn: ((a: T, b: TInner) => TResult)
  - - (a, b): TResult
    - Parameters
      a: T
      b: TInner
      Returns TResult
Returns JoinStream<T, TInner, TResult>
Inherited from AlotProto.join
- Defined in AlotProto.ts:132

joinOuter

joinOuter<TInner, TResult>(inner, getKey, getForeignKey, joinFn): JoinStream<T, TInner, TResult>
Join Full Outer
Type Parameters
- TInner = T
- TResult = T
Parameters
- inner: TInner[]
- getKey: ((x: T) => string | number)
  - - (x): string | number
    - Parameters
      x: T
      Returns string | number
- getForeignKey: ((x: TInner) => string | number)
  - - (x): string | number
    - Parameters
      x: TInner
      Returns string | number
- joinFn: ((a?: T, b?: TInner) => TResult)
  - - (a?, b?): TResult
    - Parameters
      Optionala: T
      Optionalb: TInner
      Returns TResult
Returns JoinStream<T, TInner, TResult>
Inherited from AlotProto.joinOuter
- Defined in AlotProto.ts:141

map

map<TResult>(fn): MapStream<T, TResult>
Type Parameters
- TResult
Parameters
- fn: MethodMap<T, TResult>
Returns MapStream<T, TResult>
Inherited from AlotProto.map
- Defined in AlotProto.ts:84

mapAsync

mapAsync<TResult>(fn, meta?): MapStream<T, TResult>
Type Parameters
- TResult
Parameters
- fn: MethodMap<T, TResult>
- Optionalmeta: AlotMeta
Returns MapStream<T, TResult>
Inherited from AlotProto.mapAsync
- Defined in AlotProto.ts:87

mapFull

mapFull<TResult>(fn): TResult
Type Parameters
- TResult
Parameters
- fn: ((arr: T[]) => TResult)
  - - (arr): TResult
    - Parameters
      arr: T[]
      Returns TResult
Returns TResult
Inherited from AlotProto.mapFull
- Defined in AlotProto.ts:96

mapFullAsync

mapFullAsync<TResult>(fn, opts?): Promise<TResult>
Type Parameters
- TResult
Parameters
- fn: ((arr: T[]) => Promise<TResult>)
  - - (arr): Promise<TResult>
    - Parameters
      arr: T[]
      Returns Promise<TResult>
- Optionalopts: AlotMetaAsync
Returns Promise<TResult>
Inherited from AlotProto.mapFullAsync
- Defined in AlotProto.ts:100

mapMany

mapMany<TResult>(fn): MapManyStream<T, TResult>
Type Parameters
- TResult
Parameters
- fn: MethodMapMany<T, TResult>
Returns MapManyStream<T, TResult>
Inherited from AlotProto.mapMany
- Defined in AlotProto.ts:90

mapManyAsync

mapManyAsync<TResult>(fn): MapManyStream<T, TResult>
Type Parameters
- TResult
Parameters
- fn: MethodMapMany<T, TResult>
Returns MapManyStream<T, TResult>
Inherited from AlotProto.mapManyAsync
- Defined in AlotProto.ts:93

max

max<TOut>(fn): TOut
Type Parameters
- TOut extends TAggregateNumeric
Parameters
- fn: ((x: T, i?: number) => TOut)
  - - (x, i?): TOut
    - Parameters
      x: T
      Optionali: number
      Returns TOut
Returns TOut
Inherited from AlotProto.max
- Defined in AlotProto.ts:321

maxAsync

maxAsync<TOut>(fn): Promise<TOut>
Type Parameters
- TOut extends TAggregateNumeric
Parameters
- fn: ((x: T, i?: number) => TOut)
  - - (x, i?): TOut
    - Parameters
      x: T
      Optionali: number
      Returns TOut
Returns Promise<TOut>
Inherited from AlotProto.maxAsync
- Defined in AlotProto.ts:324

maxItem

maxItem<TOut>(fn): T
Type Parameters
- TOut extends TAggregateNumeric
Parameters
- fn: ((x: T, i?: number) => TOut)
  - - (x, i?): TOut
    - Parameters
      x: T
      Optionali: number
      Returns TOut
Returns T
Inherited from AlotProto.maxItem
- Defined in AlotProto.ts:327

maxItemAsync

maxItemAsync<TOut>(fn): Promise<T>
Type Parameters
- TOut extends TAggregateNumeric
Parameters
- fn: ((x: T, i?: number) => TOut)
  - - (x, i?): TOut
    - Parameters
      x: T
      Optionali: number
      Returns TOut
Returns Promise<T>
Inherited from AlotProto.maxItemAsync
- Defined in AlotProto.ts:330

min

min<TOut>(fn): TOut
Type Parameters
- TOut extends TAggregateNumeric
Parameters
- fn: ((x: T, i?: number) => TOut)
  - - (x, i?): TOut
    - Parameters
      x: T
      Optionali: number
      Returns TOut
Returns TOut
Inherited from AlotProto.min
- Defined in AlotProto.ts:333

minAsync

minAsync<TOut>(fn): Promise<TOut>
Type Parameters
- TOut extends TAggregateNumeric
Parameters
- fn: ((x: T, i?: number) => TOut)
  - - (x, i?): TOut
    - Parameters
      x: T
      Optionali: number
      Returns TOut
Returns Promise<TOut>
Inherited from AlotProto.minAsync
- Defined in AlotProto.ts:336

minItem

minItem<TOut>(fn): T
Type Parameters
- TOut extends TAggregateNumeric
Parameters
- fn: ((x: T, i?: number) => TOut)
  - - (x, i?): TOut
    - Parameters
      x: T
      Optionali: number
      Returns TOut
Returns T
Inherited from AlotProto.minItem
- Defined in AlotProto.ts:339

minItemAsync

minItemAsync<TOut>(fn): Promise<T>
Type Parameters
- TOut extends TAggregateNumeric
Parameters
- fn: ((x: T, i?: number) => TOut)
  - - (x, i?): TOut
    - Parameters
      x: T
      Optionali: number
      Returns TOut
Returns Promise<T>
Inherited from AlotProto.minItemAsync
- Defined in AlotProto.ts:342

next(): AlotStreamIterationResult<T>
Returns AlotStreamIterationResult<T>
Inherited from AlotProto.next
- Defined in AlotProto.ts:49

nextAsync

nextAsync(): Promise<AlotStreamIterationResult<T>>
Returns Promise<AlotStreamIterationResult<T>>
Inherited from AlotProto.nextAsync
- Defined in AlotProto.ts:53

reset

reset(): this
Resets current stream to the beginning.

Returns this
Inherited from AlotProto.reset
- Defined in AlotProto.ts:64

skip

skip(count): SkipStream<T>
Parameters
- count: number
Returns SkipStream<T>
Inherited from AlotProto.skip
- Defined in AlotProto.ts:119

skipWhile

skipWhile(fn, opts?): SkipWhileStream<T>
Parameters
- fn: SkipWhileMethod<T>
- Optionalopts: TSkipWhileMethodOpts
Returns SkipWhileStream<T>
Inherited from AlotProto.skipWhile
- Defined in AlotProto.ts:122

skipWhileAsync

skipWhileAsync(fn, opts?): SkipWhileStreamAsync<T>
Parameters
- fn: SkipWhileMethodAsync<T>
- Optionalopts: TSkipWhileMethodOpts
Returns SkipWhileStreamAsync<T>
Inherited from AlotProto.skipWhileAsync
- Defined in AlotProto.ts:125

sortBy

sortBy(sortByFn, direction?): SortByStream<T>
Parameters
- sortByFn: SortMethod<T>
- Optionaldirection: "desc" | "asc"
Returns SortByStream<T>
Inherited from AlotProto.sortBy
- Defined in AlotProto.ts:162
sortBy(sortByKey, direction?): SortByStream<T>
Parameters
- sortByKey: string | keyof T
- Optionaldirection: "desc" | "asc"
Returns SortByStream<T>
Inherited from AlotProto.sortBy
- Defined in AlotProto.ts:163

sortByAsync

sortByAsync(sortByFn, direction?): SortByStream<T>
Parameters
- sortByFn: SortMethod<T>
- Optionaldirection: "desc" | "asc"
Returns SortByStream<T>
Inherited from AlotProto.sortByAsync
- Defined in AlotProto.ts:168
sortByAsync(sortByKey, direction?): SortByStream<T>
Parameters
- sortByKey: string | keyof T
- Optionaldirection: "desc" | "asc"
Returns SortByStream<T>
Inherited from AlotProto.sortByAsync
- Defined in AlotProto.ts:169

sortByLocalCompare

sortByLocalCompare(getValFn, direction?, ...params): SortByLocalCompareStream<T>
Parameters
- getValFn: ((x: T, i?: number) => string)
  - - (x, i?): string
    - Parameters
      x: T
      Optionali: number
      Returns string
- Optionaldirection: "desc" | "asc"
- Rest...params: [locales?: string | string[], options?: CollatorOptions]
Returns SortByLocalCompareStream<T>
Inherited from AlotProto.sortByLocalCompare
- Defined in AlotProto.ts:174

sum

sum(getVal, initialValue?): number
Parameters
- getVal: ((x: T, i?: number) => number)
  - - (x, i?): number
    - Parameters
      x: T
      Optionali: number
      Returns number
- OptionalinitialValue: number
Returns number
Inherited from AlotProto.sum
- Defined in AlotProto.ts:307
sum(getVal, initialValue): bigint
Parameters
- getVal: ((x: T, i?: number) => bigint)
  - - (x, i?): bigint
    - Parameters
      x: T
      Optionali: number
      Returns bigint
- initialValue: bigint
Returns bigint
Inherited from AlotProto.sum
- Defined in AlotProto.ts:308

sumAsync

sumAsync(getVal, initialValue?): Promise<number>
Parameters
- getVal: ((x: T, i?: number) => number | Promise<number>)
  - - (x, i?): number | Promise<number>
    - Parameters
      x: T
      Optionali: number
      Returns number | Promise<number>
- OptionalinitialValue: number
Returns Promise<number>
Inherited from AlotProto.sumAsync
- Defined in AlotProto.ts:312

sumBigInt

sumBigInt(getVal): bigint
Parameters
- getVal: ((x: T, i?: number) => bigint)
  - - (x, i?): bigint
    - Parameters
      x: T
      Optionali: number
      Returns bigint
Returns bigint
Inherited from AlotProto.sumBigInt
- Defined in AlotProto.ts:315

sumBigIntAsync

sumBigIntAsync(getVal, initialValue?): Promise<bigint>
Parameters
- getVal: ((x: T, i?: number) => bigint | Promise<bigint>)
  - - (x, i?): bigint | Promise<bigint>
    - Parameters
      x: T
      Optionali: number
      Returns bigint | Promise<bigint>
- OptionalinitialValue: bigint
Returns Promise<bigint>
Inherited from AlotProto.sumBigIntAsync
- Defined in AlotProto.ts:318

take

take(count): TakeStream<T>
Parameters
- count: number
Returns TakeStream<T>
Inherited from AlotProto.take
- Defined in AlotProto.ts:110

takeWhile

takeWhile(fn, opts?): TakeWhileStream<T>
Parameters
- fn: TakeWhileMethod<T>
- Optionalopts: TTakeWhileMethodOpts
Returns TakeWhileStream<T>
Inherited from AlotProto.takeWhile
- Defined in AlotProto.ts:113

takeWhileAsync

takeWhileAsync(fn, opts?): TakeWhileStreamAsync<T>
Parameters
- fn: TakeWhileMethodAsync<T>
- Optionalopts: TTakeWhileMethodOpts
Returns TakeWhileStreamAsync<T>
Inherited from AlotProto.takeWhileAsync
- Defined in AlotProto.ts:116

toArray

toArray(): T[]
Returns T[]
Inherited from AlotProto.toArray
- Defined in AlotProto.ts:247

toArrayAsync

toArrayAsync(meta?): PromiseLike<T[]>
Parameters
- meta: AlotMetaAsync = ...
Returns PromiseLike<T[]>
Inherited from AlotProto.toArrayAsync
- Defined in AlotProto.ts:259

toDictionary

toDictionary<TKey, TValue>(keyFn, valFn?): {
[key: string]: TValue;
}
Type Parameters
- TKey = string
- TValue = any
Parameters
- keyFn: ((x: T) => TKey)
  - - (x): TKey
    - Parameters
      x: T
      Returns TKey
- OptionalvalFn: ((x: T) => TValue)
  - - (x): TValue
    - Parameters
      x: T
      Returns TValue
Returns {
[key: string]: TValue;
}
- [key: string]: TValue
Inherited from AlotProto.toDictionary
- Defined in AlotProto.ts:184

toDictionaryAsync

toDictionaryAsync<TKey, TValue>(keyFn, valFn?): Promise<{
[key: string]: TValue;
}>
Type Parameters
- TKey = string
- TValue = any
Parameters
- keyFn: ((x: T) => TKey | Promise<TKey>)
  - - (x): TKey | Promise<TKey>
    - Parameters
      x: T
      Returns TKey | Promise<TKey>
- OptionalvalFn: ((x: T) => TValue | Promise<TValue>)
  - - (x): TValue | Promise<TValue>
    - Parameters
      x: T
      Returns TValue | Promise<TValue>
Returns Promise<{
[key: string]: TValue;
}>
Inherited from AlotProto.toDictionaryAsync
- Defined in AlotProto.ts:196

toMap

toMap<TKey, TValue>(keyFn, valFn?): Map<TKey, TValue>
Type Parameters
- TKey = string
- TValue = any
Parameters
- keyFn: ((x: T) => TKey)
  - - (x): TKey
    - Parameters
      x: T
      Returns TKey
- OptionalvalFn: ((x: T) => TValue)
  - - (x): TValue
    - Parameters
      x: T
      Returns TValue
Returns Map<TKey, TValue>
Inherited from AlotProto.toMap
- Defined in AlotProto.ts:213

toMapAsync

toMapAsync<TKey, TValue>(keyFn, valFn?): Promise<Map<TKey, TValue>>
Type Parameters
- TKey = string
- TValue = any
Parameters
- keyFn: ((x: T) => TKey | Promise<TKey>)
  - - (x): TKey | Promise<TKey>
    - Parameters
      x: T
      Returns TKey | Promise<TKey>
- OptionalvalFn: ((x: T) => TValue | Promise<TValue>)
  - - (x): TValue | Promise<TValue>
    - Parameters
      x: T
      Returns TValue | Promise<TValue>
Returns Promise<Map<TKey, TValue>>
Inherited from AlotProto.toMapAsync
- Defined in AlotProto.ts:229

`Static`fromObject

fromObject<TValue>(obj): Alot<{
key: string;
value: TValue;
}>
Type Parameters
- TValue
Parameters
- obj: {
  [key: string]: TValue;
  }
  - [key: string]: TValue
Returns Alot<{
key: string;
value: TValue;
}>
- Defined in alot.ts:13

`Static`fromRange

fromRange(start, endExcluded): Alot<any>
Parameters
- start: number
- endExcluded: number
Returns Alot<any>
- Defined in alot.ts:20

Class Alot<T>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Alot<T>

Properties

array

isAsync

Optionalmeta

stream

Methods

[iterator]

Returns Alot<T>

concat

Type Parameters

Parameters

Returns ConcatStream<T, TSourceB>

distinct

Returns DistinctByStream<T, string | number>

distinctBy

Parameters

Returns DistinctByStream<T, string | number>

filter

Parameters

Returns FilterStream<T>

filterAsync

Parameters

Returns FilterStreamAsync<T>

find

Parameters

Parameters

Returns boolean

Returns T

findAsync

Parameters

Parameters

Returns boolean | Promise<boolean>

Returns Promise<T>

first

Parameters

Parameters

Returns boolean

Returns T

firstAsync

Parameters

Parameters

Returns boolean | Promise<boolean>

Returns Promise<T>

forEach

Parameters

Returns ForEachStream<T>

forEachAsync

Type Parameters

Parameters

Returns ForEachStream<T>

fork

Parameters

Parameters

Returns any

Returns this

groupBy

Type Parameters

Parameters

Returns GroupByStream<T, TKey>

join

Type Parameters

Parameters

Parameters

Returns string | number

Parameters

Returns string | number

Parameters

Returns TResult

`Optional`meta