Class Enumerable

Provides a set of static methods for IEnumerable.

Index

Constructors

Methods

empty from fromObject isEnumerable range repeat

Constructors

constructor

new Enumerable(): Enumerable
Returns Enumerable

Methods

`Static`empty

empty<TResult>(): IEnumerable<TResult>
Creates an empty Enumerable.
Type Parameters
- TResult
Returns IEnumerable<TResult>
A new empty Enumerable.
Example
```
const empty = Enumerable.empty();
```
- Defined in enumerables/Enumerable.ts:52

`Static`from

from<TResult>(src: Iterable<TResult>): IEnumerable<TResult>
Creates a new Enumerable from the input Iterable.
Type Parameters
- TResult
Parameters
- src: Iterable<TResult>
  The Iterable to create an Enumerable from.
Returns IEnumerable<TResult>
A new Enumerable.
Example
```
const numbers = [1, 2, 3, 4];
const enumerable = Enumerable.from(numbers);
```
- Defined in enumerables/Enumerable.ts:23

`Static`fromObject

fromObject<TSource>(
src: TSource,
): IEnumerable<[keyof TSource, TSource[keyof TSource]]>
Creates a new Enumerable from the input object.
Type Parameters
- TSource
Parameters
- src: TSource
  The object to create an Enumerable from.
Returns IEnumerable<[keyof TSource, TSource[keyof TSource]]>
A new Enumerable.
Example
```
const obj = {
  foo: 1,
  bar: 'b'
};
const enumerable = Enumerable.from(obj);
```
- Defined in enumerables/Enumerable.ts:40

`Static`isEnumerable

isEnumerable(obj: unknown): obj is IEnumerable<unknown>
Determines if the passed in object is an Enumerable.
Parameters
- obj: unknown
  The item to test if it is an Enumerable or not.
Returns obj is IEnumerable<unknown>
True if the obj is an Enumerable. False if not.
- Defined in enumerables/Enumerable.ts:82

`Static`range

range(start: number, count: number): IEnumerable<number>
Generates a sequence of integral numbers within a specified range.
Parameters
- start: number
  The value of the first integer in the sequence.
- count: number
  The number of sequential integers to generate.
Returns IEnumerable<number>
An IEnumerable that contains a range of sequential integral numbers.
- Defined in enumerables/Enumerable.ts:62

`Static`repeat

repeat<TResult>(element: TResult, count: number): IEnumerable<TResult>
Generates a sequence that contains one repeated value.
Type Parameters
- TResult
Parameters
- element: TResult
  The value to be repeated.
- count: number
  The number of times to repeat the value in the generated sequence.
Returns IEnumerable<TResult>
An IEnumerable that contains a repeated value.

Typeparam
TResult The type of the value to be repeated in the result sequence.
- Defined in enumerables/Enumerable.ts:73