emptyFunction

2007-01-16T03:42:00Z

emptyFunction([argument...])

The emptyFunction does nothing… and returns nothing!

It is used thoughout the framework to provide a fallback function in order to cut down on conditionals. Typically you’ll find it as a default value for optional callback functions.

K

2007-01-16T03:25:00Z

K(argument) -> argument

K is Prototype’s very own identity function, i.e. it returns its argument untouched.

This is used throughout the framework, most notably in the Enumerable module as a default value for iterators.

Examples


Prototype.K('hello world!');
// -> 'hello world!'

Prototype.K(1.5);
// -> 1.5

Prototype.K(Prototype.K);
// -> Prototype.K

Prototype

2007-01-06T19:02:00Z

The Prototype namespace provides fundamental information about the Prototype library you’re using, as well as a central repository for default iterators or functions.

We say “namespace,” because the Prototype object is not intended for instantiation, nor for mixing in other objects. It’s really just… a namespace.

Your version of Prototype

Your scripts can check against a particular version of Prototype by examining Prototype.Version, which is a version string (e.g. “1.5.0”). The famous script.aculo.us library does this at load time to ensure it’s being used with a reasonably recent version of Prototype, for instance.

Browser features

Prototype also provides a (nascent) repository of browser feature information, which it then uses here and there in its source code. The idea is, first, to make Prototype’s source code more readable; and second, to centralize whatever scripting trickery might be necessary to detect the browser feature, in order to ease maintenance.

The only currently available feature detection is browser support for DOM Level 3 XPath, accessible as a boolean at Prototype.BrowserFeatures.XPath.

Default iterators and functions

Numerous methods in Prototype objects (most notably the Enumerable module) let the user pass in a custom iterator, but make it optional by defaulting to an “identity function” (an iterator that just returns its argument, untouched). This is the Prototype.K function, which you’ll see referred to in many places.

Many methods also take it easy by protecting themselves against missing methods here and there, reverting to empty functions when a supposedly available method is missing. Such a function simply ignores its potential arguments, and does nothing whatsoever (which is, oddly enough, blazing fast). The quintessential empty function sits, unsurprisingly, at Prototype.emptyFunction (note the lowercase first letter).