Mini package for creating scheduled sequences
npm i scheduled-sequence
CommonJS: const { ScheduledSequence } = require('scheduled-sequence');
ES6: import { ScheduledSequence } from 'scheduled-sequence';
💡 Pro-tip: Utilize the test file as an example
This function returns a ScheduledSequence object. This function takes a single argument sequence
which represents an array of objects of objects with properties details
(any type) and timeout
which is the time in milliseconds that will be spent before distributing the details. sequence
defaults to an empty array.
The inject
member function takes arguments details
(defaults to an empty object), timeout
(defaults to 0
), and index
which represents the index that the details will be injected into the sequence (defaults to the end of the sequence).
The remove
member function removes a detail from the sequence at a given index
(defaults to the last detail in the sequence).
This function returns an asynchronous iterator that when interpolated, returns the details of the sequence object at the determined timeouts. Example:
for await (const details of sequence.distribute()) {
console.log({ details });
}
Engineered with 💖 by @EthanThatOneKid