Ufront API Documentation

Ufront is an open source client-server web framework for Haxe. This API documentation includes all the classes used in the various Ufront libraries.

The menu on the left only shows the ufront package, which is where most of the good stuff is.The API documentation for any dependencies is included in the search and in links in the documentation, but is hidden from the menu to avoid clutter.

All packages and types (including dependencies)

express
haxe
js
mconsole
minject
mockatoo
mw
neko
nodejs
php
pushstate
sys
tink
ufront
utest
Array

An Array is a storage for values. You can access it using indexes or with its API.

ArrayAccess

ArrayAccess is used to indicate a class that can be accessed using brackets. The type parameter represents the type of the elements stored.

Bool

The standard Boolean type, which can either be true or false.

Class

An abstract type that represents a Class.

CompileTime

CompileTimeClassList
  • Copyright (c) 2013 Jason O'Neil
  • 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:

Console

An alias for mconsole.Console

Date

The Date class provides a basic structure for date and time related information. Date instances can be created by

DateTools

The DateTools class contains some extra functionalities for handling Date instances and timestamps.

Dynamic

Dynamic is a special type which is compatible with all other types.

EReg

The EReg class represents regular expressions.

Enum

An abstract type that represents an Enum type.

EnumValue

An abstract type that represents any enum value. See Type for the Haxe Reflection API.

Float

The standard Float type, this is a double-precision IEEE 64bit float.

IMap

ImportAll

Int

The standard Int type. Its precision depends on the platform.

Iterable

An Iterable is a data structure which has an iterator() method. See Lambda for generic functions on iterable structures.

Iterator

An Iterator is a structure that permits iteration over elements of type T.

Lambda

The Lambda class is a collection of methods to support functional programming. It is ideally used with 'using Lambda' and then acts as an extension to Iterable types.

List

A linked-list of elements. The list is composed of two-elements arrays that are chained together. It is optimized so that adding or removing an element does not imply copying the whole array content every time.

Map

Map allows key to value mapping for arbitrary value types, and many key types.

Math

This class defines mathematical functions and constants.

Null

Null can be useful in two cases. In order to document some methods that accepts or can return a null value, or for the Flash compiler and AS3 generator to distinguish between base values that can be null and others that can't.

PBKDF2
  • Copyright (c) 2013 Parvez Anandam, jeesmon@gmail.com, Jason O'Neil
  • All rights reserved.
  • See README for how the Haxe version of this library was derived

Reflect

The Reflect API is a way to manipulate values dynamically through an abstract interface in an untyped manner. Use with care.

Std

The Std class provides standard methods for manipulating basic types.

String

The basic String class.

StringBuf

A String buffer is an efficient way to build a big string by appending small elements together.

StringTools

This class provides advanced methods on Strings. It is ideally used with 'using StringTools' and then acts as an extension to the String class.

Sys

This class gives you access to many base functionalities of system platforms. Looks in [sys] sub packages for more system APIs.

Type

The haxe Reflection API allows retrieval of type information at runtime.

ValueType

Void

The standard Void type. Only null values can be of the type Void.

Xml

XmlType