Class reference

Description

Implements a circular buffer.

Public methods

Method

Details

add(data)

Arguments:

  • data (object())

    An arbitrary object.

Adds an arbitrary Javascript object to the buffer. The data object may be a simple type such as an integer or string or a more complex JavaScript structure such as an object or an array.

If the buffer is full the least recently added object is removed.

clear()

Clears the buffer.

get(i)

Arguments:

  • i (integer())

    The index of the object. The oldest item in the buffer has an index of 0.

Gets an object from the buffer.

getNewest()

Returns:

  • (object)

    The “newest” object.

Gets the “newest” object in the buffer. This is the object added most recently.

getOldest()

Returns:

  • (object)

    The “oldest” object.

Gets the “oldest” object in the buffer. This is the object added least recently.

getPrevious()

Returns:

  • (object)

    The previously added object.

Gets the object added before the most recent one.

Description

Simple class allowing multiple values to be stored under one logical cookie name in the browser.

IMu.Cookie objects are not usually created directly. Instead they get created when IMu.Cookies.get() is called.

New in version 2.0.

Public methods

Method

Details

remove()

Removes this cookie from the cookie store.

save()

Saves the current set of values back to the browser's cookie store.

Examples

  1. Add a cookie called Test to the browser's store. The Test cookie will contain two values: alpha and beta:

    var testCookie = IMu.Cookies.get('Test', {alpha: 1, beta: "two"});
    testCookie.save();

  2. Update the value of "beta" in the "Test" cookie.:

    var testCookie = IMu.Cookies.get('Test', {alpha: 1, beta: "two"}); testCookie.values.beta = 'zwei';
    testCookie.save();

Description

Static class providing access to IMu-specific cookies in the browser.

Each IMu-specific can have several values.

New in version 2.0.

Public methods

Method

Details

get(name, defaults)

Arguments:

  • name (string())

    The name of the cookie to find.

  • defaults (object())

    A set of default values to be set of the cookie does not already exist.

Returns:

  • (IMu.Cookie)

    The cookie.

Checks for a cookie called name in the browser and returns its contents as an IMu.Cookie.

If the cookie does not exist, a new one is created.

Description

Class for IMu-specific exceptions.

Extends the standard JavaScript Error class.

Public methods

Method

Details

toString()

Returns:

  • (string)
    A string version of the exception.

IMu.Error overrides the standard toString.

Description

Static class for formatting strings.

Public methods

Method

Details

convert(value, format)

Arguments:

  • value (mixed())

    The value to be converted.

  • format (string())

    A conversion format specifier.

Returns:

  • (string)

    The string representation of value.

Converts a JavaScript value to an appropriate string representation.

format(format)

Arguments:

  • format (string())

    The string to be formatted, including format specifiers.

Returns:

  • (string)

    The formatted string.

Replaces specifiers in the format argument with string representations of values passed as additional arguments.

sprintf()

A synonym for the format method.

vsprintf()

 

Description

Static class to simplify writing to the browser's JavaScript console.

Public methods

Method

Details

log(format)

Arguments:

  • format (string())

    The string to be formatted, including format specifiers.

Writes a message to the JavaScript console if available.

The message is formatted using the IMu.Format.format method and prefixed with the current time.