ku4js-kernel

kodmunki™ utilities for JavaScript kernel is both a stand alone library and also acts as the kernel for the ku4js-* suite of libraries that make up the ku4js Framework an Object Oriented JavaScript Framework.

ku4js-kernel contains a vast number of powerful classes and patterns including: value objects, asserters, collections, math, geometry, finance, mediators, specifications, state machine abstractions and many more!

Documentation

The following documentation describes each class in the ku4js-kernel library. It is organized to follow the directory structure found in /src ordered by lowest level constructs first. All instantiable classes can be instantiated using the $.className() syntax. All constructors are empty unless otherwise noted.

The API tables in each section of the documentation contain three columns.

Base

Asserters

ku4js-kernel contains an assortment of tested assertion functions that are useful in performing common logic tasks. By using ku4js-kernel asserters, not only are you able to leverage succinct powerful assertions, but your assertions will also clearly reveal the intention of the code.

Class

Class is a foundational construct from which numerous other classes inherit. This construct is leveraged heavily throughout the ku4js Framwork suite. It offers subclasses a common property API that includes

• get()
• set()
• property() //a getter/setter.

It also exposes the inheritance API $.Class.extend(). To subclass JavaScript classes with ku4js-kernel using the kernel simply do the following:

function myClass() {
    myClass.base.call(this); //This line is required and set the correct scope.

    /*Add further constructor items, initializers and any other relevant code here*/

}
myClass.prototype = {

    /*All prototype methods go here*/

};
$.Class.extend(myClass, $.Class); //We are creating our subclass here. myClass is a subclass of $.Class

$.myClass = function() { return new myClass(); } //This line is optional. It will make this class pulic. Without this line this class will be internal.

With the above implementation. A developer can now call $.myClass() to instantiate a new myClass that contains get(), set(), and property(). It is important to note that many ku4js-* classes expose an inheritence interface and can be inherited using the same convention as class. For example, to inherit from $.mediator, a developer would simply replace $.Class.extend(myClass, $.Class) in the example above with $.Class.extend(myClass, $.mediator.Class) and they would now be inheriting from $.mediator.

math

Convenient math operations, and some that fix odd bugs.

str

Convenient string operations.

uid

A 32 character random unique ID.

Account

emailAddress

An email address value object.

phoneNumber

A phone number value object.

properName

A proper name value object.

Collections

hash

A key value pair collection.

list

A indexed collection

Datetime

dayPoint

A value object that represents a day.

Finance

money

A value object that represents money.

Geometry

coord

A value object object representing a coordinate.

point

A value object object representing a coordinate.

rectangle

A value object object representing a coordinate.

vector

A value object object representing a coordinate.

Patterns

iterator

A value object object representing a coordinate.

mediator

mediator notes!

This is a very powerful and useful pattern, but it comes with developer responsibilities. Below are some gotchas that may arise when used irresponsibly, ignorantly, or unknowingly.

• You can setting the mediator to throwErrors or logErrors. Exceptions that arise in a methods that execute through notification can be difficult to debug. Setting how the mediator handles these exceptions can be of great help in development.

observer

Documentation Coming Soon

queue

Documentation Coming Soon

specification

Constructor: $.spec(func:function). The function passed must take a value parameter and return a boolean value.

Spec Example:

var oneSpec = $.spec(function(value) { return value === 1; }),
    twoSpec = $.spec(function(value) { return value === 2; }),
    oneOrTwoSpec = oneSpec.or(twoSpec);

console.log(oneSpec.isSatisfiedBy(1)) //Evaluates as true
console.log(twoSpec.isSatisfiedBy(1)) //Evaluates as false
console.log(oneOrTwoSpec.isSatisfiedBy(2)) //Evaluates as true
console.log(oneOrTwoSpec.isSatisfiedBy(3)) //Evaluates as false

stack

Documentation Coming Soon