ArrayMethods | array-factory

Methods added to Array and ReadonlyArray interfaces

Type parameters

T: Iterable<any>

Hierarchy

ArrayMethods

Index

Methods

factoryFilter

factoryFilter<S>(callback: FilterCallback<T, S>, thisArg?: any): Generator<S, void, unknown>
factoryFilter(callback: FilterCallback<T, unknown>, thisArg?: any): Generator<IterType<T>, void, unknown>

- Defined in index.ts:243
example
```
const myArray = [1, 2, 3]
// Only even numbers
for (const item of myArray.factoryFilter(el => !(el % 2))) {
  console.log(item)
}
```
Type parameters
- S: any
  
  Type of all filtered values
Parameters
- callback: FilterCallback<T, S>
  
  Filter callback
- Optional thisArg: any
  
  Optional argument. Binds this for the callback
Returns Generator<S, void, unknown>
- Defined in index.ts:248
Parameters
- callback: FilterCallback<T, unknown>
- Optional thisArg: any
Returns Generator<IterType<T>, void, unknown>

factoryFlat

factoryFlat<D>(depth?: D): Generator<FlatArray<IterType<T>[], D>, void, unknown>

- Defined in index.ts:268
Modified for TypeScript from a Mozilla implementation
see
{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flat#use_generator_function}

example
```
const myArray = [1, 2, [3, 4]]
for (const item of myArray.factoryFlat()) {
  console.log(item)
}
// 1, 2, 3, 4
```
Type parameters
- D: number = 1
  
  Depth
Parameters
- Optional depth: D
  
  How many arrays deep to flatten. Can be Infinity for a fully flat array
Returns Generator<FlatArray<IterType<T>[], D>, void, unknown>

factoryFlatMap

factoryFlatMap<U>(callback: MapCallback<T, U>, thisArg?: any): Generator<U extends readonly InnerArr[] ? InnerArr : U, void, unknown>

- Defined in index.ts:286
example
```
const myArray = [1, 2, 3]
for (const item of myArray.factoryFlatMap(el => [el, el * 2])) {
  console.log(item)
}
// 1, 2, 2, 4, 3, 6
```
Type parameters
- U
  
  Mapped type
Parameters
- callback: MapCallback<T, U>
  
  flatMap callback
- Optional thisArg: any
  
  Optional argument. Binds this for callback
Returns Generator<U extends readonly InnerArr[] ? InnerArr : U, void, unknown>

factoryMap

factoryMap<U>(callback: MapCallback<T, U>, thisArg?: any): Generator<U, void, unknown>

- Defined in index.ts:227
example
```
const myArray = [1, 2, 3]
for (const item of myArray.factoryMap(el => el * 2)) {
  console.log(item)
}
```
Type parameters
- U
  
  Mapped type
Parameters
- callback: MapCallback<T, U>
  
  Map callback
- Optional thisArg: any
  
  Optional argument. Binds this for the callback
Returns Generator<U, void, unknown>

Type parameters

T: Iterable<any>

Hierarchy

Index

Methods

Methods

factoryFilter

Type parameters

S: any

Parameters

callback: FilterCallback<T, S>

Optional thisArg: any

Returns Generator<S, void, unknown>

Parameters

callback: FilterCallback<T, unknown>

Optional thisArg: any

Returns Generator<IterType<T>, void, unknown>

factoryFlat

Type parameters

D: number = 1

Parameters

Optional depth: D

Returns Generator<FlatArray<IterType<T>[], D>, void, unknown>

factoryFlatMap

Type parameters

U

Parameters

callback: MapCallback<T, U>

Optional thisArg: any

Returns Generator<U extends readonly InnerArr[] ? InnerArr : U, void, unknown>

factoryMap

Type parameters

U

Parameters

callback: MapCallback<T, U>

Optional thisArg: any

Returns Generator<U, void, unknown>