Boo —at a glance—

Boo provides easy-modo prototypical inheritance and object composition for JavaScript, through mixins and prototype cloning.

Guides

  • Discover Boo

    A tour through Boo’s concepts and how you can leverage them to structure better your code-base.

  • API Reference

    A quick reference on the minimal Boo’s API, including plenty of usage examples and cross-references.

Installing

With Node.js and NPM, you can do the easy-modo install:

$ npm install boo

# Then require it as usual
$ node
node> var boo = require('boo')

In the browser, you have to include the script tag pointing to the boo.js file:

<script src="/path/to/boo.js"></script>
<script type="text/javascript">
  // `boo' is in the global scope now
</script>

Platform Support

Boo should support all ECMAScript 5-compliant platforms. It’s been successfully tested in the following platforms:

  • 8.0
  • 5.1
  • 11.0
  • 11.62
  • 18.0
  • 0.6.x

For the legacy platforms (like IE’s JScript), you’ll have to provide support for the following methods:

  • Object.keys
  • Object.create
  • Object.getPrototypeOf
  • Array.prototype.forEach
  • Array.prototype.filter
  • Array.prototype.indexOf

The nice es5-shim library takes care of handling all of those for you.

Support

Boo uses the Github tracker for tracking bugs and new features.

Licence

Boo is licensed under the delicious and premissive MIT licence. You can happily copy, share, modify, sell or whatever — refer to the actual licence text for less information:

$ less LICENCE.txt

# The MIT License
#
# Copyright (c) 2011 Orphoundation
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

(END)