Module assert

• • deepEqual(actual, expected)
  • equal(actual, expected)
  • fail(options)
  • isFalse(value)
  • isNaN(value)
  • isNotNaN(value)
  • isNotNull(value)
  • isNotUndefined(value)
  • isNull(value)
  • isTrue(value)
  • isUndefined(value)
  • matches(value, expr)
  • notDeepEqual(actual, expected)
  • notEqual(actual, expected)
  • notStrictEqual(actual, expected)
  • ok(value)
  • strictEqual(actual, expected)
  • stringContains(value, pattern)
  • throws(func, expectedError)

• Class ArgumentsError(message)

  • message
  • stackTrace

• Class AssertionError(options)

  • actual
  • expected
  • message
  • name
  • stackTrace

Module binary

• • toByteArray(str, charset)
  • toByteString(str, charset)

• Class Binary()

• Class ByteArray(contentOrLength, [charset])

  • byteAt(offset)
  • charAt(offset)
  • charCodeAt(offset)
  • concat(args...)
  • copy(start, end, target, targetOffset)
  • decodeToString(encoding)
  • every(callback, thisObj)
  • filter(callback, thisObj)
  • forEach(fn, thisObj)
  • get(offset)
  • indexOf(sequence, start, stop)
  • lastIndexOf(sequence, start, stop)
  • map(callback, thisObj)
  • pop()
  • push(num...)
  • reduce(callback, initialValue)
  • reduceRight(callback, initialValue)
  • reverse()
  • set(offset, value)
  • shift()
  • slice(begin, end)
  • some(callback, thisObj)
  • sort(comparator)
  • splice(index, howMany, elements...)
  • split(delimiter, options)
  • toArray()
  • toByteArray()
  • toByteString()
  • toString()
  • unshift(num...)
  • unwrap()
  • wrap(bytes)
  • length

• Class ByteString(content, charset)

  • byteAt(offset)
  • charAt(offset)
  • charCodeAt(offset)
  • concat(args...)
  • copy(start, end, target, targetStart)
  • decodeToString(charset)
  • get(offset)
  • indexOf(sequence, start, stop)
  • lastIndexOf(sequence, start, stop)
  • slice(begin, end)
  • split(delimiter, options)
  • toArray()
  • toByteArray()
  • toByteString()
  • toString()
  • unwrap()
  • wrap(bytes)
  • length

Module console

• • assert(expression, msg...)
  • dir(obj)
  • error(msg...)
  • info(msg...)
  • log(msg...)
  • time(name)
  • timeEnd(name)
  • trace(msg...)
  • warn(msg...)

Module fs

• • absolute(path)
  • base(path, ext)
  • canonical(path)
  • changeGroup(path, group)
  • changeOwner(path, owner)
  • changePermissions(path, permissions)
  • copy(from, to)
  • copyTree(from, to)
  • directory(path)
  • exists(path)
  • extension(path)
  • getAttributes(path)
  • group(path)
  • hardLink(existing, link)
  • isAbsolute(path)
  • isDirectory(path)
  • isFile(path)
  • isLink(path)
  • isReadable(path)
  • isRelative(path)
  • isWritable(path)
  • iterate(path)
  • join()
  • lastModified(path)
  • list(path)
  • listDirectoryTree(path)
  • listTree(path)
  • makeDirectory(path, permissions)
  • makeTree(path)
  • move(source, target)
  • normal(path)
  • open(path, options)
  • openRaw(path, options)
  • owner(path)
  • path()
  • permissions(path)
  • read(path, options)
  • readLink(path)
  • relative(source, target)
  • remove(path)
  • removeDirectory(path)
  • removeTree(path)
  • resolve(paths...)
  • same(pathA, pathB)
  • sameFilesystem(pathA, pathB)
  • size(path)
  • split(path)
  • symbolicLink(existing, link)
  • touch(path, mtime)
  • workingDirectory()
  • write(path, content, options)

• Class Path()

  • from(target)
  • join()
  • listPaths()
  • resolve()
  • to(target)
  • toString()
  • valueOf()
  • constructor

Module globals

• • addToClasspath(path)
  • clearInterval(id)
  • clearTimeout(id)
  • defineClass(clazz)
  • gc()
  • getRepository(path)
  • getResource(path)
  • include(moduleId)
  • load(filename...)
  • module.resolve(path)
  • module.singleton(id, factory)
  • print(args...)
  • privileged(func)
  • quit()
  • require(moduleId)
  • seal(obj)
  • setInterval(callback, delay, args...)
  • setTimeout(callback, delay, [args...])
  • spawn(func)
  • sync(func, [obj])
  • arguments
  • console
  • environment
  • exports
  • global
  • module
  • module.directory
  • module.exports
  • module.id
  • module.path
  • module.uri
  • require.extensions
  • require.main
  • require.paths

Module io

• Class MemoryStream(binaryOrNumber)

  • close()
  • closed()
  • flush()
  • read(maxBytes)
  • readInto(buffer, begin, end)
  • readable()
  • seekable()
  • writable()
  • write(source, begin, end)
  • content
  • length
  • position

• Class Stream()

  • close()
  • closed()
  • copy(output)
  • flush()
  • forEach(fn, [thisObj])
  • read(maxBytes)
  • readInto(buffer, begin, end)
  • readable()
  • seekable()
  • skip(num)
  • unwrap()
  • writable()
  • write(source, begin, end)
  • inputStream
  • outputStream

• Class TextStream(io, options, buflen)

  • close()
  • copy(output)
  • flush()
  • forEach(callback, [thisObj])
  • iterator()
  • next()
  • print()
  • read()
  • readInto()
  • readLine()
  • readLines()
  • readable()
  • seekable()
  • writable()
  • write()
  • writeLine(line)
  • writeLines(lines)
  • content
  • raw

Module net

• Class DatagramSocket()

  • bind(host, port)
  • close()
  • connect(host, port)
  • disconnect()
  • getTimeout()
  • isBound()
  • isClosed()
  • isConnected()
  • localAddress()
  • receive(length, buffer)
  • receiveFrom(length, buffer)
  • remoteAddress()
  • send(data)
  • sendTo(host, port, data)
  • setTimeout(timeout)

• Class ServerSocket()

  • accept()
  • bind(host, port)
  • close()
  • getTimeout()
  • isBound()
  • isClosed()
  • localAddress()
  • setTimeout(timeout)

• Class Socket()

  • bind(host, port)
  • close()
  • connect(host, port, [timeout])
  • getStream()
  • getTimeout()
  • isBound()
  • isClosed()
  • isConnected()
  • localAddress()
  • remoteAddress()
  • setTimeout(timeout)

Module system

• • exit(status)
  • print()
  • args
  • env
  • stderr
  • stdin
  • stdout

Module test

• • run(scope, name, writer)
  • getStackTrace
  • getType
  • jsDump
  • run.prototype.fileName
  • run.prototype.lineNumber
  • run.prototype.message
  • run.prototype.stackTrace

Module ringo/args

• Class Parser()

  • addOption(shortName, longName, argument, helpText)
  • help()
  • parse(args, result)

Module ringo/base64

• • decode(str, encoding)
  • encode(str, encoding)

Module ringo/buffer

• Class Buffer(args...)

  • digest(algorithm)
  • forEach(fn)
  • reset()
  • toString()
  • write(args...)
  • writeln(args...)
  • length

Module ringo/concurrent

• Class Semaphore(permits)

  • signal(permits)
  • tryWait(timeout, permits)
  • wait(permits)

Module ringo/daemon

• • destroy()
  • init()
  • start()
  • stop()

Module ringo/encoding

• Class Decoder(charset, strict, capacity)

  • clear()
  • close()
  • decode(bytes, start, end)
  • hasPendingInput()
  • read()
  • readFrom(source)
  • readLine(includeNewline)
  • toString()
  • length

• Class Encoder(charset, strict, capacity)

  • clear()
  • close()
  • encode(string, start, end)
  • toByteArray()
  • toByteString()
  • toString()
  • writeTo(sink)
  • length

Module ringo/engine

• • addHostObject(javaClass)
  • addRepository(repo)
  • addShutdownHook(funcOrObject, sync)
  • asJavaObject(object)
  • asJavaString(object)
  • createSandbox(modulePath, globals, options)
  • getCurrentWorker(obj)
  • getErrors()
  • getOptimizationLevel()
  • getRepositories()
  • getRhinoContext()
  • getRhinoEngine()
  • getRingoHome()
  • getWorker()
  • loadJars(location, recursive)
  • setOptimizationLevel(level)
  • properties
  • version

Module ringo/events

• Class EventEmitter()

  • emit(type, [args...])
  • listeners(type)
  • on(type, listener)
  • removeAllListeners(type)
  • removeListener(type, listener)

• Class JavaEventEmitter(classOrInterface, eventMapping)

  • addListener(type, listener)
  • addSyncListener(type, listener)
  • emit(type, [args...])
  • on(type, listener)
  • removeAllListeners(type)
  • removeListener(type, listener)
  • impl

Module ringo/httpclient

• • del(url, data)
  • get(url, data)
  • post(url, data)
  • put(url, data)
  • request(options)

• Class BinaryPart(data, fileName, contentType)

• Class Exchange(url, options)

  • connection
  • content
  • contentBytes
  • contentLength
  • contentType
  • cookies
  • encoding
  • headers
  • message
  • status
  • url

• Class TextPart(data, charset, fileName)

Module ringo/logging

• • getJavaStack(error, prefix)
  • getLogger(name)
  • getScriptStack(error, prefix)
  • setConfig(resource, watchForUpdates)

• Class Logger(name, impl)

  • debug()
  • error()
  • info()
  • isDebugEnabled()
  • isErrorEnabled()
  • isInfoEnabled()
  • isTraceEnabled()
  • isWarnEnabled()
  • trace()
  • warn()

Module ringo/mime

• • mimeType(fileName, fallback)
  • MIME_TYPES

Module ringo/profiler

• • profile(func, maxFrames)

• Class Profiler()

  • formatResult(maxFrames)
  • getFrames()
  • getScriptFrame(cx, script)
  • toString()

Module ringo/promise

• Class Deferred()

  • resolve(result, isError)
  • promise

• Class Promise()

  • then(callback, errback)
  • wait(timeout)

• Class PromiseList(promise...)

Module ringo/shell

• • printError(xcept, errors, verbose)
  • printResult(value, writer)
  • quit(status)
  • read()
  • readln(prompt, echoChar)
  • start(engine)
  • write(args...)
  • writeln(args...)

Module ringo/subprocess

• • command(command, [arguments...], [options])
  • createProcess(args)
  • status(command, [arguments...], [options])
  • system(command, [arguments...], [options])
  • status.prototype.close
  • status.prototype.flush
  • status.prototype.readable
  • status.prototype.seekable
  • status.prototype.writable
  • status.prototype.write

• Class Process()

  • connect(input, output, errput)
  • kill()
  • wait()
  • stderr
  • stdin
  • stdout

Module ringo/term

• • write(args...)
  • writeln(args...)
  • BLACK
  • BLUE
  • BOLD
  • CYAN
  • GREEN
  • INVERSE
  • LIGHT_GREY
  • MAGENTA
  • ONBLACK
  • ONBLUE
  • ONCYAN
  • ONGREEN
  • ONMAGENTA
  • ONRED
  • ONWHITE
  • ONYELLOW
  • RED
  • RESET
  • UNDERLINE
  • WHITE
  • YELLOW

• Class TermWriter()

  • isEnabled()
  • setEnabled(flag)
  • write(args...)
  • writeln(args...)

Module ringo/worker

• Class Worker(moduleId)

  • postMessage(data, [syncCallbacks])
  • terminate()

• Class WorkerPromise(moduleId, message, [syncCallbacks])

  • then(callback, errback)
  • wait(timeout)

Module ringo/zip

• • ZipIterator(resource)

• Class ZipFile(path)

  • close()
  • getSize(name)
  • getTime(name)
  • isDirectory(name)
  • isFile(name)
  • open(name)
  • entries

Module ringo/httpserver/builder

• Class HttpServerBuilder()

  • addEventSource(path, onConnect, initParams)
  • addFilter(path, filter, initParams)
  • addWebSocket(path, onConnect, onCreate, initParams)
  • configure(xmlPath)
  • enableConnectionStatistics()
  • enableSessions(options)
  • http(options)
  • https(options)
  • serveApplication(mountpoint, app, options)
  • serveStatic(mountpoint, directory, options)
  • start()

Module ringo/httpserver/eventsource

• Class EventSource()

  • comment(msg)
  • data(msg)
  • event(name, msg)
  • close

Module ringo/httpserver/httpserver

• Class HttpServer()

  • addContext(context)
  • configure(xmlPath)
  • createConnector(connectionFactory, options)
  • createHttpConfig(options)
  • createHttpConnector(options)
  • createHttpListener(options)
  • createHttpsConnector(options)
  • createHttpsListener(options)
  • createSslContextFactory(options)
  • enableSessions()
  • getConnectionStatistics()
  • getContextHandlerCollection()
  • getHandlerCollection()
  • isRunning()
  • serveApplication()
  • serveStatic()
  • destroy
  • enableConnectionStatistics
  • start
  • stop

Module ringo/httpserver/index

• • build(options)
  • destroy()
  • init(path)
  • main(path)
  • start()
  • stop()
  • HttpServer

Module ringo/httpserver/utils

• • parseOptions(args, defaults)

Module ringo/httpserver/websocket

• • EventSource

• Class WebSocket()

  • close()
  • isOpen()
  • send(message)
  • sendBinary(byteArray, offset, length)
  • sendBinaryAsync(byteArray, offset, length)
  • sendString(message)
  • sendStringAsync(message)

Module ringo/jsgi/connector

• • AsyncResponse(request, timeout)
  • handleRequest(moduleId, functionObj, request)

Module ringo/jsgi/eventsource

• • isEventSourceRequest(request)

• Class EventSource(request)

  • comment(comment)
  • data(data)
  • event(name, data)
  • start(headers, heartBeatInterval)
  • close
  • ping
  • response

Module ringo/jsgi/response

• • addHeaders(headers)
  • bad()
  • created()
  • error()
  • forbidden()
  • gone()
  • html(html...)
  • json(object)
  • jsonp(callback, object)
  • notFound()
  • notModified()
  • ok()
  • range(request, representation, size, contentType, timeout, maxRanges)
  • redirect(location)
  • setCharset(charsetName)
  • setContentType(contentType)
  • setHeaders(headers)
  • setStatus(code)
  • static(resource, contentType)
  • text(text...)
  • unauthorized()
  • unavailable()
  • xml(xml)

• Class JsgiResponse(base)

  • addHeaders(headers)
  • bad()
  • binary(data, contentType)
  • created()
  • error()
  • forbidden()
  • gone()
  • html(html...)
  • json(object)
  • jsonp(callback, object)
  • notFound()
  • notModified()
  • ok()
  • redirect(location)
  • setCharset(charsetName)
  • setContentType(contentType)
  • setHeaders(headers)
  • setStatus(code)
  • stream(stream, contentType)
  • text(text...)
  • unauthorized()
  • unavailable()
  • xml(xml)
  • body
  • headers
  • status

Module ringo/utils/arrays

• • contains(array, val)
  • intersection(array,...)
  • max(array)
  • min(array)
  • peek(array)
  • remove(array, val)
  • union(array1,...)

Module ringo/utils/dates

• • add(date, delta, unit)
  • after(a, b)
  • before(a, b)
  • checkDate(fullYear, month, day)
  • compare(a, b)
  • dayOfYear(date)
  • daysInFebruary(date)
  • daysInMonth(date)
  • daysInYear(date)
  • diff(a, b, unit)
  • firstDayOfWeek(locale)
  • format(date, format, locale, timezone)
  • fromUTCDate(year, month, date, hour, minute, second, millisecond)
  • inPeriod(date, periodStart, periodEnd, periodStartOpen, periodEndOpen)
  • isLeapYear(date)
  • overlapping(aStart, aEnd, bStart, bEnd)
  • parse(str, format, locale, timezone, lenient)
  • quarterInFiscalYear(date, fiscalYearStart)
  • quarterInYear(date)
  • resetDate(date)
  • resetTime(date)
  • secondOfDay(date)
  • toISOString(date, withTime, withTimeZone, withSeconds, withMilliseconds)
  • toInstant(date)
  • toOffsetDateTime(date)
  • weekOfMonth(date, locale)
  • weekOfYear(date, locale)
  • yearInCentury(date)

Module ringo/utils/files

• • createTempFile(prefix, suffix, directory, permissions)
  • isHidden(file)
  • resolveId(parent, child)
  • resolveUri(arbitrary)
  • supportsFileAttributeView(attribute)
  • roots
  • separator

• Class PosixPermissions(permissions)

  • toJavaFileAttribute()
  • toJavaPosixFilePermissionSet()
  • toString()
  • value

Module ringo/utils/http

• • BufferFactory(data, encoding)
  • TempFileFactory(data, encoding)
  • canonicalRanges(ranges)
  • getMimeParameter(headerValue, paramName)
  • isFileUpload(contentType)
  • isUrlEncoded(contentType)
  • mergeParameter(params, name, value)
  • parseFileUpload(request, params, encoding, streamFactory)
  • parseParameters(input, params, encoding)
  • parseRange(rangeStr, size)
  • setCookie(key, value, days, options)
  • urlEncode(object, separator, equals)

• Class Headers(headers)

  • add(name, value)
  • contains(name)
  • get(name)
  • set(name, value)
  • toString()
  • unset(name)

• Class ResponseFilter(body, filter)

  • forEach(fn)

Module ringo/utils/numbers

• • format(number, fmt, locale)
  • times(num, fun)

Module ringo/utils/objects

• • clone(object, circular, depth, prototype)
  • merge(obj...)

Module ringo/utils/strings

• • Sorter(field, order)
  • b16decode(str, encoding)
  • b16encode(str, encoding)
  • b64decode(string, encoding)
  • b64encode(string, encoding)
  • capitalize(string, limit)
  • compose(one)
  • contains(string, substring, fromIndex)
  • count(string, pattern)
  • digest(string, algorithm)
  • endsWith(string, substring)
  • entitize(string)
  • escapeHtml(string)
  • escapeRegExp(str)
  • format(format)
  • getCommonPrefix(str1, str2)
  • group(string, interval, str, ignoreWhiteSpace)
  • isAlpha(string)
  • isAlphanumeric(string)
  • isDate(string, format, locale, timezone, lenient)
  • isDateFormat(string)
  • isEmail(string)
  • isFileName(string)
  • isFloat(string)
  • isHexColor(string)
  • isInt(string)
  • isLowerCase(string)
  • isNumeric(string)
  • isUpperCase(string)
  • isUrl(string)
  • join(str1, str2, str3)
  • pad(string, fill, length, mode)
  • random(len, mode)
  • repeat(string, num)
  • startsWith(string, substring)
  • titleize(string, amount)
  • toAlphanumeric(string)
  • toCamelCase(string)
  • toDashes(string)
  • toDate(string, format, timezone)
  • toFileName(string)
  • toHexColor(string)
  • toUnderscores(string)
  • y64decode(string, encoding)
  • y64encode(string, encoding)

Module ringo/utils/test

• • getStackTrace(trace)
  • getType(obj)
  • jsDump(value, lvl)

Module ringo/httpserver/context/application

Module ringo/httpserver/context/context

Module ringo/httpserver/context/static