Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AsyncArray<T>

Type parameters

  • T

Hierarchy

  • Array<T>
    • AsyncArray

Indexable

[n: number]: T

Index

Properties

Private consumers

consumers: Array<function> = []

length

length: number

Static Array

Array: ArrayConstructor

Methods

__@iterator

  • __@iterator(): IterableIterator<T>
  • Returns IterableIterator<T>

__@unscopables

  • __@unscopables(): object
  • Returns object

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

concat

  • concat(items: ConcatArray<T>[]): T[]
  • concat(items: (T | ConcatArray<T>)[]): T[]
  • Parameters

    • Rest items: ConcatArray<T>[]

    Returns T[]

  • Parameters

    • Rest items: (T | ConcatArray<T>)[]

    Returns T[]

consume

  • consume(): Promise<T>

copyWithin

  • copyWithin(target: number, start: number, end: number): this
  • Parameters

    • target: number
    • start: number
    • Optional end: number

    Returns this

entries

  • entries(): IterableIterator<[number, T]>
  • Returns IterableIterator<[number, T]>

every

  • every(callbackfn: function, thisArg: any): boolean
  • Parameters

    • callbackfn: function
        • (value: T, index: number, array: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • Optional thisArg: any

    Returns boolean

fill

  • fill(value: T, start: number, end: number): this
  • Parameters

    • value: T
    • Optional start: number
    • Optional end: number

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg: any): S[]
  • filter(callbackfn: function, thisArg: any): T[]
  • Type parameters

    • S: T

    Parameters

    • callbackfn: function
        • (value: T, index: number, array: T[]): boolean
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns boolean

    • Optional thisArg: any

    Returns S[]

  • Parameters

    • callbackfn: function
        • (value: T, index: number, array: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • Optional thisArg: any

    Returns T[]

find

  • find<S>(predicate: function, thisArg: any): S | undefined
  • find(predicate: function, thisArg: any): T | undefined
  • Type parameters

    • S: T

    Parameters

    • predicate: function
        • (this: void, value: T, index: number, obj: T[]): boolean
        • Parameters

          • this: void
          • value: T
          • index: number
          • obj: T[]

          Returns boolean

    • Optional thisArg: any

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: T, index: number, obj: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • obj: T[]

          Returns unknown

    • Optional thisArg: any

    Returns T | undefined

findIndex

  • findIndex(predicate: function, thisArg: any): number
  • Parameters

    • predicate: function
        • (value: T, index: number, obj: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • obj: T[]

          Returns unknown

    • Optional thisArg: any

    Returns number

forEach

  • forEach(callbackfn: function, thisArg: any): void
  • Parameters

    • callbackfn: function
        • (value: T, index: number, array: T[]): void
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns void

    • Optional thisArg: any

    Returns void

includes

  • includes(searchElement: T, fromIndex: number): boolean
  • Parameters

    • searchElement: T
    • Optional fromIndex: number

    Returns boolean

indexOf

  • indexOf(searchElement: T, fromIndex: number): number
  • Parameters

    • searchElement: T
    • Optional fromIndex: number

    Returns number

join

  • join(separator: string): string
  • Parameters

    • Optional separator: string

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: T, fromIndex: number): number
  • Parameters

    • searchElement: T
    • Optional fromIndex: number

    Returns number

map

  • map<U>(callbackfn: function, thisArg: any): U[]
  • Type parameters

    • U

    Parameters

    • callbackfn: function
        • (value: T, index: number, array: T[]): U
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns U

    • Optional thisArg: any

    Returns U[]

pop

  • pop(): T | undefined
  • Returns T | undefined

produce

  • produce(v: T): number

push

  • push(items: T[]): number
  • Parameters

    • Rest items: T[]

    Returns number

reduce

  • reduce(callbackfn: function): T
  • reduce(callbackfn: function, initialValue: T): T
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Parameters

    • callbackfn: function
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    Returns T

  • Parameters

    • callbackfn: function
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    • initialValue: T

    Returns T

  • Type parameters

    • U

    Parameters

    • callbackfn: function
        • (previousValue: U, currentValue: T, currentIndex: number, array: T[]): U
        • Parameters

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns U

    • initialValue: U

    Returns U

reduceRight

  • reduceRight(callbackfn: function): T
  • reduceRight(callbackfn: function, initialValue: T): T
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Parameters

    • callbackfn: function
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    Returns T

  • Parameters

    • callbackfn: function
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    • initialValue: T

    Returns T

  • Type parameters

    • U

    Parameters

    • callbackfn: function
        • (previousValue: U, currentValue: T, currentIndex: number, array: T[]): U
        • Parameters

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns U

    • initialValue: U

    Returns U

reverse

  • reverse(): T[]
  • Returns T[]

shift

  • shift(): T | undefined
  • Returns T | undefined

slice

  • slice(start: number, end: number): T[]
  • Parameters

    • Optional start: number
    • Optional end: number

    Returns T[]

some

  • some(callbackfn: function, thisArg: any): boolean
  • Parameters

    • callbackfn: function
        • (value: T, index: number, array: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • Optional thisArg: any

    Returns boolean

sort

  • sort(compareFn: function): this
  • Parameters

    • Optional compareFn: function
        • (a: T, b: T): number
        • Parameters

          • a: T
          • b: T

          Returns number

    Returns this

splice

  • splice(start: number, deleteCount: number): T[]
  • splice(start: number, deleteCount: number, items: T[]): T[]
  • Parameters

    • start: number
    • Optional deleteCount: number

    Returns T[]

  • Parameters

    • start: number
    • deleteCount: number
    • Rest items: T[]

    Returns T[]

toLocaleString

  • toLocaleString(): string
  • Returns string

toString

  • toString(): string
  • Returns string

unshift

  • unshift(items: T[]): number
  • Parameters

    • Rest items: T[]

    Returns number

values

  • values(): IterableIterator<T>
  • Returns IterableIterator<T>

Generated using TypeDoc