Skip to main content
Version: v1

IntervalCollectionIterator Class

Signature​

export declare class IntervalCollectionIterator<TInterval extends ISerializableInterval>

Type Parameters​

ParameterConstraintDescription
TIntervalISerializableInterval

Constructors​

ConstructorDescription
(constructor)(collection, iteratesForward, start, end)Constructs a new instance of the IntervalCollectionIterator class

Methods​

MethodReturn TypeDescription
next(){ value: TInterval; done: boolean; }

Constructor Details​

(constructor)​

Constructs a new instance of the IntervalCollectionIterator class

Signature​

constructor(collection: IntervalCollection<TInterval>, iteratesForward?: boolean, start?: number, end?: number);

Parameters​

ParameterModifiersTypeDescription
collectionIntervalCollection<TInterval>
iteratesForwardoptionalboolean
startoptionalnumber
endoptionalnumber

Method Details​

next​

Signature​

next(): {
value: TInterval;
done: boolean;
};

Returns​

Return type: { value: TInterval; done: boolean; }