System Modules

The default memory resolver exposes the standard run-time library of Fate. This library consists of several modules that provide a variety of functionality.

array

Provides functionality for manipulating Arrays.

first(array)

Returns the first item of the provided array (or null if the array is empty).

last(array)

Returns the last item of the provided array (or null if the array is empty).

length(value)

If it is an array, returns the length of the provided value (otherwise 0).

join([delimiter], array)

Return the result of joining the elements of the provided array. Each element will be concatenated into a string separated by the specified delimiter (or ' ').

empty(array)

Returns true or false depending on whether or not the provided array is empty.

object

Provides functionality for manipulating Objects.

keys(value)

Returns the keys of the Object or indexes of the Array passed to it. If the Array is sparse (has gaps) it will only return the indexes with assigned values.

values(value)

Returns the values of the Object or Array passed to it. If the array is sparse (has gaps) it will only return the assigned values.

string

Provides functionality for manipulating strings.

build(string, supportFunctions)

Converts the provided string into an Fate interpolation function.

lower(string)

Converts the provided string to lower-case and returns the result.

upper(string)

Converts the provided string to upper-case and returns the result.

title(string)

Converts the provided string to title-case and returns the result. Title case converts the first character of each word to upper-case, and the rest to lower-case.

split([delimiter], string)

Splits the provided string wherever the specified delimiter (or whitespace) is encountered and returns the result.

string(value)

Converts the provided value to a string and returns the result.

math

Provides basic mathematical functions and constants.

Constants

abs(number)

Returns the absolute value of the provided number.

acos(number)

Returns the arc-cosine of the provided number (in radians).

asin(number)

Returns the arc-sine of the provided number (in radians).

atan(y, x)

Returns the arc-tangent of the provided number (in radians).

atan2(number)

Returns the arc-tangent of the provided coordinates.

avg([number])

Returns the average of the numbers in the provided array.

ceil(number)

Rounds the provided number upward to the nearest integer and returns the result.

cos(number)

Returns the cosine of the provided number (in radians).

exp(x)

Returns E to the power of x, where E is Euler's number.

floor

Rounds the provided number downward to the nearest integer and returns the result.

log(number)

Returns the natural logarithm of the provided number.

max([number])

Returns the maximum value among the numbers in the provided array.

median([number])

Returns the mathematical median of the numbers in the provided array.

min([number])

Returns the minimum value among the numbers in the provided array.

pow(x, y)

Returns x raised to the power of y.

random()

Returns a random number between 0 (inclusive) and 1 (exclusive).

range(start, end)

Creates an integer range generator. When iterated over, will yield all of the integer numbers in the defined range (inclusive).

round(number)

Rounds the provided number to the nearest integer and returns the result.

sin(number)

Returns the sine of the provided number (in radians).

sqrt(number)

Returns the sqaure root of the provided number.

sum([number])

Returns the sum of the numbers in the provided array.

tan(number)

Returns the tangent of the provided number (in radians).

number(value)

Converts the provided value to a number and returns the result (or NaN).

pattern

The pattern module contains several pre-defined Patterns that can be reused in one's code.

String

true if the matched value is a String, empty or not.

EmptyString

true if the matched value is an empty String.

NonEmptyString

true if the matched value is a non-empty String.

Number

true if the matched value is a number.

PositiveNumber

true if the matched value is positive number, excluding zero.

NonNegativeNumber

true if the matched value is a number that is zero or greater.

NegativeNumber

true if the matched value is a number that is less than zero.

Integer

true if the matched value is an integer.

PositiveInteger

true if the matched value is a positive integer, excluding zero.

NonNegativeInteger

true if the matched value is an integer that is zero or greater.

NegativeInteger

true if the matched value is an integer that is less than zero.

Array

true if the matched value is an Array, empty or not.

EmptyArray

true if the matched value is an empty Array.

NonEmptyArray

true if the matched value is an Array of at least one element.

Object

true if the matched value is an Object.

Boolean

true if the matched value is a boolean true or false.

ArrayOf(Pattern)

true if the matched value is an Array of values that match the specified Pattern.

Constraints

The Pattern returned by ArrayOf can be further constrained to a minimum and maximum length.

# PersonArray matches between 1 and 10 elements, inclusive
let PersonArray = pattern.ArrayOf(Person).MinLength(1).MaxLength(10)