Index: RingoJs 0.8 API

Module assert

• • deepEqual(Object, Object)
  • equal(Object, Object)
  • fail(Object|String)
  • isFalse(Object)
  • isNaN(Object)
  • isNotNaN(Object)
  • isNotNull(Object)
  • isNotUndefined(Object)
  • isNull(Object)
  • isTrue(Object)
  • isUndefined(Object)
  • matches(String, RegExp)
  • notDeepEqual(Object, Object)
  • notEqual(Object, Object)
  • notStrictEqual(Object, Object)
  • ok(Object)
  • strictEqual(Object, Object)
  • stringContains(String, String)
  • throws(Object, Object)

• Class ArgumentsError(String)

  • message
  • stackTrace

• Class AssertionError(Object)

  • actual
  • expected
  • message
  • name
  • stackTrace

Module binary

• Class Binary()

• Class ByteArray(Binary|Array|String|Number, String)

  • concat(Binary|Array)
  • copy(Number, Number, ByteArray, Number)
  • decodeToString(String)
  • every(Function, Object)
  • filter(Function, Object)
  • forEach(Function, Object)
  • indexOf(Number|Binary, Number, Number)
  • lastIndexOf(Number|Binary, Number, Number)
  • map(Function, Object)
  • pop()
  • push(Number)
  • reduce(Function, Object)
  • reduceRight(Function, Object)
  • reverse()
  • shift()
  • slice(Number, Number)
  • some(Function, Object)
  • sort(Function)
  • splice(Number, Number, Number)
  • split(Number|Binary, Object)
  • toArray()
  • toByteArray()
  • toByteString()
  • toString()
  • unshift(Number)
  • wrap(Binary)
  • length

• Class ByteString(Binary|Array|String, String)

  • byteAt(Number)
  • concat(Binary|Array)
  • copy(Number, Number, ByteArray, Number)
  • decodeToString(String)
  • get(Number)
  • indexOf(Number|Binary, Number, Number)
  • lastIndexOf(Number|Binary, Number, Number)
  • slice(Number, Number)
  • split(Number|Binary, Object)
  • toArray()
  • toByteArray()
  • toByteString()
  • toString()

• Class String()

  • toByteArray(String)
  • toByteString(String)

Module console

• • assert(, ...)
  • dir(Object)
  • error()
  • info(...)
  • log()
  • time(String)
  • timeEnd(String)
  • trace(...)
  • warn()

Module fs

• • absolute()
  • base(String, String)
  • canonical(string)
  • changeGroup(String, String|Number)
  • changeOwner(String, String|Number)
  • changePermissions(String, Number|Object)
  • changeWorkingDirectory(string)
  • copy(String, String)
  • copyTree(String, String)
  • directory(String)
  • exists(string)
  • extension(String)
  • group(String)
  • hardLink(string, string)
  • isAbsolute()
  • isDirectory(string)
  • isFile(string)
  • isLink(string)
  • isReadable(string)
  • isRelative()
  • isWritable(string)
  • iterate(string)
  • join()
  • lastModified(string)
  • list(string)
  • listDirectoryTree()
  • listTree()
  • makeDirectory(string, number|object)
  • makeTree()
  • move(string, string)
  • normal()
  • open(String, Object)
  • openRaw(String, Object, Object)
  • owner(String)
  • path()
  • permissions(String)
  • read(String, Object)
  • readLink(string)
  • relative(String, String)
  • remove(string)
  • removeDirectory(String)
  • removeTree()
  • resolve()
  • same(string, string)
  • sameFilesystem(string, string)
  • size(string)
  • split(String)
  • symbolicLink(string, string)
  • touch(string, Date)
  • workingDirectory()
  • write(String, binary.Binary|String, Object)

• Class Path()

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

• Class Permissions(number|object, )

  • toNumber()
  • update(Number|Object)

Module io

• Class MemoryStream(Binary|number)

  • close()
  • closed()
  • flush()
  • read()
  • readInto()
  • readable()
  • seekable()
  • skip()
  • writable()
  • write()
  • content
  • length
  • position

• Class Stream()

  • close()
  • closed()
  • copy(Stream)
  • flush()
  • forEach(Function, Object)
  • read(Number)
  • readInto(ByteArray, Number, Number)
  • readable()
  • seekable()
  • skip(Number)
  • unwrap()
  • writable()
  • write(Binary, Number, Number)
  • inputStream
  • outputStream

• Class TextStream(Stream, Object, number)

  • close()
  • copy()
  • flush()
  • forEach(Function, Object)
  • iterator()
  • next()
  • print()
  • read()
  • readInto()
  • readLine()
  • readLines()
  • readable()
  • seekable()
  • writable()
  • write()
  • writeLine()
  • writeLines()
  • content
  • raw

Module system

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

Module test

• • getStackTrace(java.lang.StackTraceElement)
  • getType()
  • jsDump(Object, Number)
  • jsDump.indent()
  • jsDump.quote()
  • run(String|Object, String, Object)

Module ringo/args

• Class Parser()

  • addOption(String, String, String, String)
  • help()
  • parse(Array, Object)

Module ringo/base64

• • decode(String, String)
  • encode(String|Binary, String)

Module ringo/buffer

• Class Buffer()

  • digest()
  • forEach()
  • reset()
  • toString()
  • write()
  • writeln()
  • length

Module ringo/daemon

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

Module ringo/encoding

• Class Decoder(, , )

  • clear()
  • close()
  • decode(binary.Binary, Number, Number)
  • hasPendingInput()
  • read()
  • readFrom(binary.Binary)
  • readLine(Boolean)
  • toString()
  • length

• Class Encoder(, , )

  • clear()
  • close()
  • encode(String, Number, Number)
  • toByteArray()
  • toByteString()
  • toString()
  • writeTo()
  • length

Module ringo/engine

• • addHostObject(JavaClass)
  • addRepository(Repository)
  • asJavaObject(Object)
  • asJavaString(Object)
  • createSandbox(Array, Object, Object)
  • evaluate(String, Object)
  • getErrors()
  • getOptimizationLevel()
  • getRepositories()
  • getRhinoContext()
  • getRhinoEngine()
  • getRingoHome()
  • setOptimizationLevel(Number)
  • properties
  • version

Module ringo/events

• Class EventEmitter()

  • addListener(string, function)
  • emit(string, ...)
  • listeners(string)
  • on(string, function)
  • removeAllListeners(string)
  • removeListener(string, function)

Module ringo/global

Module ringo/httpclient

• • del(String, Object|String, Function, Function)
  • get(String, Object|String, Function, Function)
  • post(String, Object|String|Binary|Stream, Function, Function)
  • put(String, Object|String|Binary|Stream, Function, Function)
  • request(Object)

• Class Exchange()

  • wait()
  • content
  • contentBytes
  • contentChunk
  • contentExchange
  • contentType
  • cookies
  • done
  • encoding
  • headers
  • status

Module ringo/httpserver

• • destroy()
  • init()
  • main(String)
  • start()
  • stop()

• Class Context()

  • addServlet(string, Servlet, Object)
  • addWebSocket(String, Function)
  • serveApplication(function|object, RhinoEngine)
  • serveStatic(string)

• Class Server(Object)

  • destroy()
  • getContext(string, string|array, Object)
  • getDefaultContext()
  • getJetty()
  • isRunning()
  • start()
  • stop()

• Class WebSocket()

  • close()
  • isOpen()
  • send()
  • onclose
  • onmessage

Module ringo/jsdoc

• • parseResource(Resource)

• Class ScriptRepository(String)

  • exists()
  • getPath()
  • getScriptResource(String)
  • getScriptResources(Boolean)

Module ringo/logging

• • getJavaStack(Error, String)
  • getLogger(string)
  • getScriptStack(Error, String)
  • setConfig(Resource, Boolean)

• Class Logger(, )

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

Module ringo/markdown

• • process(String)

• Class Markdown(Object)

  • process(String)

Module ringo/mime

• • mimeType(string, string)
  • MIME_TYPES

Module ringo/mustache

• • to_html(String, Object)
  • name
  • version

Module ringo/parser

• • getName(AstNode)
  • getTypeName(AstNode)
  • isName(Object)
  • Token

• Class Parser(Object)

  • parse(Resource|String, string)
  • visit(Resource|String, Function, string)

Module ringo/profiler

• • profile(Function, number)

• Class Profiler()

  • formatResult()
  • getFrames()
  • getScriptFrame(, )
  • toString()

Module ringo/promise

• • defer()
  • promises(promise)

• Class Deferred()

  • resolve(Object, boolean)
  • promise

• Class Promise()

  • then(function, function)
  • wait(number)

Module ringo/scheduler

• • clearInterval(object)
  • clearTimeout(object)
  • setInterval(function, number, ...)
  • setTimeout(function, number, ...)

Module ringo/shell

• • printError(Exception, Boolean)
  • printResult(, )
  • quit(Number)
  • read()
  • readln(String, String)
  • start()
  • write()
  • writeln()

Module ringo/subprocess

• • command(String, Object)
  • createProcess(Object)
  • status(String, Object)
  • system(String, Object)

• Class Process()

  • connect(Stream, Stream, Stream)
  • kill()
  • wait()
  • stderr
  • stdin
  • stdout

Module ringo/term

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

• Class TermWriter(Stream)

  • isEnabled()
  • setEnabled(boolean)
  • write()
  • writeln()

Module ringo/zip

• • ZipIterator(Stream|String)

• Class ZipFile(String)

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

Module ringo/jsgi/connector

• • handleRequest(String, Function, Object)

• Class AsyncResponse(Object, Number, Boolean)

  • close()
  • flush()
  • start(Number, Object)
  • write(String|Binary, String)

Module ringo/jsgi/response

• • charset(string)
  • error(String)
  • html(string)
  • json(object)
  • notFound(String)
  • redirect(String)
  • static(String|Resource, String)
  • xml(xml|string)

Module ringo/utils/arrays

• • contains(Object)
  • intersection(Array)
  • max()
  • min()
  • partition()
  • peek()
  • remove(Object)
  • union(Array)

Module ringo/utils/dates

• • add(Date, Number, String)
  • after(Date, Date)
  • before(Date, Date)
  • checkDate(Number, Number, Number)
  • compare(Date, Date)
  • dayOfYear(Date)
  • daysInFebruary(Date)
  • daysInMonth(Date)
  • daysInYear(Date)
  • diff(Date, Date, String)
  • firstDayOfWeek(String|java.util.Locale)
  • format(Date, String, String|java.util.Locale, String|java.util.TimeZone)
  • fromUTCDate(Number, Number, Number, Number, Number, Number)
  • inPeriod(Date, Date, Date, Boolean, Boolean)
  • isLeapYear(Date)
  • overlapping(Date, Date, Date, Date)
  • parse(String)
  • quarterInFiscalYear(Date, Date)
  • quarterInYear(Date)
  • resetDate(Date)
  • resetTime(Date)
  • secondOfDay(Date)
  • toISOString(Date, Boolean, Boolean, Boolean, Boolean)
  • weekOfMonth(Date, String|java.util.Locale)
  • weekOfYear(Date, String|java.util.Locale)
  • yearInCentury(Date)

Module ringo/utils/files

• • createTempFile(String, String, String)
  • isHidden(String)
  • resolveId(String, String)
  • resolveUri(...)
  • roots
  • separator

Module ringo/utils/http

• • BufferFactory(Object, String)
  • TempFileFactory(Object, String)
  • getMimeParameter(String, String)
  • isFileUpload(String)
  • isUrlEncoded(String)
  • mergeParameter(Object, String, String)
  • parseFileUpload(Object, Object, string, function)
  • parseParameters(Binary|String, Object, String)
  • setCookie(String, String, Number, Object)
  • urlEncode(Object)

• Class Headers(Object)

  • add(String, String)
  • contains(String)
  • get(String)
  • set(String, String)
  • toString()
  • unset(String)

• Class ResponseFilter(Object, Function)

  • forEach(Function)

Module ringo/utils/numbers

• • format(Number, String, String)
  • times(Number, Function)

Module ringo/utils/objects

• • clone(Object, Object, boolean)
  • merge(Object)

Module ringo/utils/strings

• • Sorter(String, Number)
  • b16decode(String, String)
  • b16encode(String|Binary, String)
  • b64decode(String, String)
  • b64encode(String|Binary, String)
  • capitalize(String, Number)
  • compose(String)
  • contains(String, String, Number)
  • count(String, String)
  • digest(String, String)
  • endsWith(String, String)
  • entitize(String)
  • escapeHtml(String)
  • escapeRegExp(String)
  • format(String)
  • getCommonPrefix(String, String)
  • group(String, Number, String, Boolean)
  • isAlpha()
  • isAlphanumeric()
  • isDateFormat(String)
  • isEmail(String)
  • isFileName(String)
  • isHexColor(String)
  • isNumeric()
  • isUrl(String)
  • join(String, String, String)
  • pad(String, String, Number, Number)
  • random(Number, Number)
  • repeat(String, Number)
  • startsWith(String, String)
  • stripTags(String)
  • titleize(String)
  • toAlphanumeric()
  • toCamelCase(String)
  • toDashes(String)
  • toDate(String, String, Object)
  • toFileName(String)
  • toHexColor(String)
  • toUnderscores(String)
  • unwrap(Boolean, String)