RingoJS API v0.5

• binary

  This module provides implementations of the Binary, ByteArray, and ByteString classes as defined in the CommonJS Binary/B proposal.

  The JavaScript Binary class serves as common base class for ByteArray and ByteString and can't be instantiated. ByteArray implements a modifiable and resizable byte buffer, while ByteString implements an immutable byte sequence. The ByteArray and ByteString constructors can take several arguments. Have a look at the proposal for details.

  When passed to a Java method that expects a byte array, instances of these class are automatically unwrapped. Use the {@link #unwrap()} method to explicitly get the wrapped Java byte array.

• core/array

  Adds useful methods to the JavaScript Array type.

• core/date

  Adds useful methods to the JavaScript Date type.

• core/json

  RingoJS provides native JSON support, so applications don't need to require this package in order to make use of JSON. It is here for backwards compatibility only.

• core/number

  Adds useful methods to the JS Number type.

• core/object

  Adds useful methods to the JavaScript Object type.

• core/regexp

• core/string

  Adds useful methods to the JavaScript String type.

• fs

  This module provides an implementation of "fs" as defined by the CommonJS Filesystem/A proposal.

  The "fs" module provides a file system API for the manipulation of paths, directories, files, links, and the construction of file streams in addition to the functions exported by fs-base.

• fs-base

  This module provides an implementation of "fs-base" as defined by the CommonJS Filesystem/A/0 proposal.

• io

  This module implements the Stream/TextStream classes as per the CommonJS IO/A proposal.

• packages

  Package loading utility module. In the top-level namespace for Tusk compatibility.

• ringo/admin/create

  Script to create a new RingoJS web application.

• ringo/admin/install

  Download and install a RingoJS package from a zip URL

• ringo/admin/main

• ringo/args

  A parser for command line options. This parser supports various option formats:

  -a -b -c (multiple short options)
  -abc (multiple short options combined into one)
  -a value (short option with value)
  -avalue (alternative short option with value)
  --option value (long option with value)
  --option=value (alternative long option with value)

• ringo/base64

• ringo/buffer

• ringo/encoding

• ringo/engine

• ringo/fileutils

  A collection of file related utilities.

• ringo/functional

• ringo/httpclient

  A scalable HTTP client that provides both synchronous and asynchronous modes of operation.

• ringo/httpserver

• ringo/jsdoc

• ringo/jsgi

• ringo/logging

  This module provides generic logging support. It uses Apache log4j by default, but can be used with any Logging framework supported by SLF4J.

  If the first argument passed to any of the logging methods is a string containing any number of curly bracket pairs ({}), the logger will interpret it as format string and use any following arguments to replace the curly bracket pairs. If an argument is an Error or Java Exception object, the logger will render a stack trace for it and append it to the log message.

• ringo/markdown

  A fast and extensible Markdown formatter.

• ringo/middleware/basicauth

  Basic Authentication middleware. To apply authentication to parts of your website add something like this to your config.js with the long string being a SHA1 digest of the user's password:

  exports.auth = {
      '/protected/path': {
          admin: "30b93f320076de1304c34673f9f524f7ea7db709"
      }
  };

• ringo/middleware/error

• ringo/middleware/etag

• ringo/middleware/gzip

• ringo/middleware/notfound

• ringo/middleware/profiler

• ringo/middleware/responselog

• ringo/middleware/transaction

• ringo/parser

  This module provides an interface to the Rhino parser.

• ringo/profiler

  A profiler for measuring execution time of JavaScript functions. Note that you need to run with optimization level -1 for profiling to work. Running the profiler on optimized code will produce no data.

• ringo/promise

• ringo/scheduler

  This module provides support for scheduling invocation of functions.

• ringo/shell

• ringo/skin

• ringo/skin/filters

  Implements some useful macro filters.

• ringo/skin/macros

• ringo/storage/filestore

• ringo/storage/googlestore

• ringo/storage/memstore

• ringo/storage/querysupport

• ringo/storage/storeutils

• ringo/subprocess

• ringo/term

  A module for printing ANSI terminal escape sequences. This module provides a number of useful color and style constants, and a replacement for the print function optimized for styled output.

• ringo/unittest

• ringo/utils

• ringo/webapp

• ringo/webapp/continuation

• ringo/webapp/daemon

• ringo/webapp/env

• ringo/webapp/fileupload

• ringo/webapp/mime

• ringo/webapp/parameters

• ringo/webapp/request

  Adds convenience properties and methods to a JSGI 0.3 request object.

• ringo/webapp/response

• ringo/webapp/util

• ringo/zip

  This module provides classes to uncompress zip files and streams.

• sandbox

  A compatibility module for Narwhal's sandbox. RingoJS is auto-reloading by default, so this is just a proxy to require().

• system

  This module provides an implementation of the system module compliant to the CommonJS System/1.0 specification.

  Beyond the standard, a "print" function and some properties for Narwhal compatibility are provided.