omnikit

Omnikit is a JavaScript utility bundle, which contains Optional class, collections, math and so on.

Note: First version contains only few features. I will add more features. Stay tuned.

Install(without Node.js / on Browsers)

Copy build/omnikit.min.js into your project directory, and load the file from your HTML file.

<script src="omnikit.min.js"></script>
<script>
  // Write your code here!
</script>

Other files(lib, src, etc.) are for Node.js, so you can ignore them.

Install(with Node.js)

Install omnikit into your project.

npm install omnikit --save

Then import modules that you need. For example, Optional, Stack and Random.

const { Optional, Stack, Random } = require('omnikit');

Basic Usage

For details, see API Document.

ranges

omnikit provides python-like simple range iterator.

for(const value of range(0, 10)) {
  console.log(value); // 0, 1, 2, 3, ..., 9
}

You can also use more specific ranges.

inclusiveRange(0, 10); // 0, 1, 2, ..., 10
exclusiveRange(0, 10); // 1, 1, 2, ..., 9
openClosedRange(0, 10); // 1, 2, 3, ..., 10
closedOpenRange(0, 10); // same as range(0, 10)

All range functions receive 3rd argument as step.

range(0, 10, 0.5); // 0, 0.5, 1.0, ..., 9.5

A step value can be negative.

To convert range to array, use toArray() method.

range(0, 10).toArray();

Optional

Optional class represent nullable(undefinable) value, which is inspired by Java and Swift.

const opt = new Optional('hello');
const opt2 = opt.map((val) => val + ' world');
const str = opt2.flatMap((val) => val);
console.log(str); // hello world

Random

Random class generate random values with a seed.

const random = new Random();
// const randomWithSeed = new Random(12345);

console.log(random.next());
console.log(random.nextInt(5, 10)); // from 5 to 10

conditions

const cond1 = isNull(null); // true
const cond2 = isUndefined(undefined); // true

Timer

Timer class provides periodical execution.

const timer = new Timer(1000); // every 1000ms
timer.addEventListener('tick', () => console.log('Hi');
timer.start();

// To stop the timer, use stop method.
// timer.stop();

You can also create an once timer.

const timer = new Timer(1000, { once: true }); // after 1000ms
timer.addEventListener('tick', () => console.log('Hi');
timer.start();

Stack and Queue

Stack is LIFO(Last In First Out) and Queue is FIFO(First In First Out).

const stack = new Stack();
stack.push(1);
stack.push(2);
console.log(stack.pop()); // 2

const queue = new Queue();
queue.enqueue(1);
queue.enqueue(2);
console.log(queue.dequeue()); // 1