Operator

Description

Examples

+  

Concatenate text values into a single text value.

To concatenate static text, surround it with double quotation marks. To concatenate double quotation marks, you need to use a backslash (\) as an escape character.

Equivalent to the concat(text) function.

=> Jane - 28

=> "GreatProduct"

[ ]  

Extracts a single character from a text value.

Equivalent to the charAt(number) function.

=> J

Operator

Description

Examples

==  

Is equal to. Determines whether two text values are the same or not. Case sensitive comparison.

=> false

=> true

!=  

Not equal to. Determines whether two text values are different. Case sensitive comparison.

=> true

=> false

<  

Determines whether one text value precedes another in alphabetical order.

Roughly corresponds to the localeCompare(text) function returning -1.

=> true

=> false

<=  

Determines whether one text value precedes or matches another in alphabetical order.

Roughly corresponds to the localeCompare(text) function returning either 0 or -1.

=> true

=> true

>  

Determines whether one text value follows another in alphabetical order.

Roughly corresponds to the localeCompare(text) function returning a positive 1.

=> false

=> true

>=  

Determines whether one text value follows or matches another in alphabetical order.

Roughly corresponds to the localeCompare(text) function returning either 0 or 1.

=> true

=> false

Filter

Description

Examples

upper

Makes a text value uppercase.

Equivalent to the toUpperCase() function.

=> HELLO!

lower

Makes a text value lowercase.

Equivalent to the toLowerCase() function.

=> hello!

initcap : forceLower

Capitalizes the first character in a text value and (optionally) makes the rest of the text lowercase.

=> MacDonald

=> Macdonald

titlecaps : forceLower

Capitalizes each word in a text value and (optionally) makes the rest of the text lowercase.

=> Marty McFly

=> Marty Mcfly

contains : textToFind

Determines if a text value contains another text value. The search is case sensitive.

Equivalent to the includes(text) function.

=> true

=> false

else : text

Tests whether a text value is empty, and if so, supplies an alternative text value.

=> John

=> client

Method

Description

Examples

textValue.charAt(number)

Extracts a single character from a text value at the position indicated by number.

Equivalent to use of the [ ] operator.

=> S

textValue.charCodeAt(number)

Returns an integer between 0 and 65535 representing the UTF-16 code unit at the position indicated by number.

=> 65

textValue.codePointAt(number)

Returns a non-negative integer that is the Unicode code point value at the position indicated by number.

=> 9733

textValue.concat(text1[, text2, …])

Concatenates the text arguments onto the "calling" text value.

To concatenate static text, surround it with double quotation marks. To concatenate double quotation marks, you need to use a backslash (\) as an escape character.

Roughly equivalent to use of the + operator.

=> Bob - 43

=> "GreatProduct"

textValue.endsWith(text)

Determines whether textValue ends with text.  Case sensitive.

=> true

textValue.first(count)

Extract count characters from the beginning of textValue.

=> quick

textValue.includes(text[, startAt])

Determines whether textValue contains a specific substring (text) or not. The search is case sensitive.

If startAt is specified, it searches textValue only from that position onwards.

Similar to the contains filter.

=> true

=> false

textValue.indexOf(text[, start])

Finds an occurrence of text in textValue starting from an optional start position. (start is 0 by default.) If no occurrence of text is found, the result will be -1. The search is case sensitive.

=> 6

=> 7

textValue.last(count)

Extract count characters from the end of textValue.

=> fox

textValue.lastIndexOf(text[, start])

Finds the last occurrence of text in textValue starting from an optional start position. (start is the full length of textValue by default.) If no occurrence of text is found, the result will be -1. The search is case sensitive.

=> 7

=> 2

textValue.localeCompare(text)

Determines whether textValue comes before, or after, or is the same as, the given text string in sort order.

=> -1 => ant precedes boy

=> 0 => no difference in sort order

=> 1 => boy follows ant

textValue.length 

Returns the length in characters of a text value.

=> 15

textValue.padEnd(length[, padding])

Pads textValue by appending a given padding string (repeated, if needed) so the resulting value reaches the given length.

If padding is omitted, spaces are used by default.

=> boyyy

textValue.padStart(length[, padding])

Pads textValue by prepending a given padding string (repeated, if needed) so the resulting value reaches the given length.

If padding is omitted, spaces are used by default.

=> whwhat?

textValue.repeat(count)

Causes textValue to be repeated count times.

=> beep beep beep

textValue.replace(oldText, newText)

Replaces a single occurrence (within textValue) of oldText with newText. Comparison is case sensitive.

=> hat now

textValue.replaceAll(oldText, newText)

Replaces all occurrences (within textValue) of oldText with newText. Comparison is case sensitive.

=> bog dog

textValue.search(pattern)

Searches within textValue for a substring that matches pattern, and returns the position in the string (if found) or -1 (if not found).

pattern is a text value containing a JavaScript regular expression, although RegExp flags (g,   i, m, etc.) are not allowed.

=> 0

=> -1

textValue.slice(start[, end])

Extracts the part of textValue that begins at start and ends before end.

If start or end is negative, it counts backwards from the end of textValue rather than from the beginning.

If end is omitted, the extracted value will go from start to the end of textValue.

=> bcde

=> bcd

=> abc

textValue.split([separator[, limit]])

Turns a text value into a list of text values by splitting it at each instance of separator.

If separator contains multiple characters, that entire character sequence must be found in order to split.

If separator is omitted or does not occur in textValue, the returned list will contain only one item (textValue).

If separator appears at the beginning or end of textValue, or both, the array begins, ends, or both begins and ends, respectively, with an empty text value.

If separator is an empty text value (""), the result is a list of text values, each a single character of textValue.

=> [ "a", "b", "c" ]

=> [ "Hello", "there", "" ]

(Two spaces after "there" causes an empty text value in the list, and the limit of 3 caps the number of items returned.)

textValue.startsWith(text)

Determines whether textValue starts with text.  Case sensitive.

=> false

textValue.strip(characters, fromStart, fromEnd)

Strips any occurrences of the given characters from the start, the end, or both the start and end of textValue.

If fromEnd is omitted, it defaults to true.  If both fromStart and fromEnd are omitted, they both default to true.

=> b

=> aaab

=> bccc

textValue.substr(start[, count])

Extract a substring of count characters starting at start. If count is omitted, the extracted substring goes from start to the end of textValue.

=> old

=> old fox

textValue.substring(start[, end])

Extract a substring beginning at position start and ending before position end.

=> old

=> old fox

textValue.toInt()

Parses textValue and returns an integer.

=> 64

textValue.toLowerCase()

Makes textValue lowercase.

Equivalent to lower filter.

=> hello!

textValue.toUpperCase()

Makes textValue uppercase.

Equivalent to upper filter.

=> HELLO!

textValue.trim()

Removes whitespace from both the beginning and end of textValue.

Whitespace includes spaces, non-breaking spaces, tabs, and line termination characters.

=> Hello world!

textValue.trimEnd()

Removes whitespace from the end of textValue.  trimRight() is an alias to this method.

textValue.trimStart()

Removes whitespace from the beginning of textValue.  trimLeft() is an alias of this method.

Function

Description

Examples

text.fromCharCode(num1[, num2, …])

Returns a text value created from the specified sequence of UTF-16 code units.

=> ½+¾=

text.fromCodePoint(num1[, num2, …])

Returns a text value created from the specified sequence of Unicode code points.

=> ☃★♲你

Operator

Description

Examples

left == right

Determines whether any value is equal to another value.

Special note: you must use two equals signs. In JavaScript, a single equals (=) is used to assign a value to a variable. Knackly does not support this syntax.

=> true

left != right

Determines whether any value is not equal to another value.

=> true

left < right

Determines whether one number value or date value is less than another.

=> true

left <= right

Determines whether one number value or date value is less than or equal to another.

=> true

left > right

Determines whether one number or date value is greater than another.

left >= right

Determines whether one number or date value is greater than or equal to another

Operator

Description

Examples

left && right

Logical AND: the && operator will return a "truthy" value only if both its operands are "truthy".

If the left-hand operand is falsy, the result will be whatever the value of the left-hand operand is.

If the left-hand operand is truthy, the result will be whatever the value of the right-hand operand is.

=> true

=> John Smith (if Client is non-null)
 => null (if Client is null/not yet answered)

=> ""

left || right

Logical OR: the || operator will return a "truthy" value if either of its operands are "truthy".

If the left-hand operand is truthy, the result will be whatever the value of the left-hand operand is.

If the left-hand operand is falsy, the result will be whatever the value of the right-hand operand is.

=> true

=> false

! operand

Logical NOT: the ! operator will return true if its single operand is falsy, or false if its operand is truthy.

=> false

=> true

=> false (if Client is answered)

=> true (if Client is null / not answered)

condition ? value1 : value2

Conditional operator: returns value1 if condition is truthy, otherwise it returns value2. Can be nested.

Simple example:

Nested and cleanly formatted:

Testing for "answeredness":

Operator

Description

Examples

+

Add together two numeric values

-

Subtract two numeric values

* 

Multiply two numeric values

/

Divide two numeric values

%

Returns the remainder after dividing the left operand by the right operand.

=> 1

Filter

Description

Examples

format:general[:negative[:zero]]

Formats a numeric value into text.

You can optionally supply separate format strings for positive numbers, negative numbers, and zero. The first (general) format given will be used if the zero and/or negative format is omitted.

Format strings are fully specified in numeral.js's documentation:
http://numeraljs.com/#format

In addition to those supported by numeral.js, Knackly also supports format strings "a" and "A" to get spreadsheet column-style numbering.

=> 10,000.00

=> -550 %

=> 0025

=> AB

cardinal

Spells out a cardinal number in words.

=> one hundred twenty-three

ordinal

Spells out an ordinal number in words

=> one hundred twenty-third

ordsuffix

Provides the appropriate ordinal abbreviation suffix (without the number itself).

=> the 22^nd of the month

else:text

Tests whether a number value is zero (falsy), and if so, supplies an alternative text value.

Function

Description

Examples

math.abs(x)

Returns the absolute value of x.

=> 5

math.cbrt(x)

Returns the cube root of x.

math.ceil(x)

Returns the smallest integer greater than or equal to x.

=> 2

=> -1

math.clz32(x)

Count leading zeros in 32-bit binary representation

math.exp(power)

Computes Euler's number (e) to the specified power.

=> 2.71828

=> 20.08554

math.expm1(x)

Returns a number representing e^x - 1

math.floor(x)

Returns the nearest integer that is less than or equal to the value.

=> 1

math.fround(x)

math.hypot(value1[, value2, …])

The square root of the sum of squares of the given arguments.

math.imul(a, b)

C-like 32-bit multiplication of a and b

math.log(x)

Natural logarithm (base e) of a given number

math.log10(x)

Base 10 logarithm of a given number

=> 3

math.log1p(x)

Natural logarithm (base 3) of 1 plus the given number

math.log2(x)

Base 2 logarithm of a given number

=> 10

math.max(value1[, value2, …])

Returns the largest of the given numbers

math.min(value1[, value2, …])

Returns the smallest of the given numbers

math.pow(base, power)

Returns a n umber representing the given base raised to the given power (exponent).

=> 27

=> 1

math.random()

A floating-point pseudo-random number between 0 (inclusive) and 1 (exclusive).

math.round(x)

The value of the given number (x) rounded to the nearest integer.

If the fractional portion of the argument is greater than 0.5, the argument is rounded to the integer with the next higher absolute value. If it is less than 0.5, the argument is rounded to the integer with the lower absolute value.  If the fractional portion is exactly 0.5, the argument is rounded to the next integer in the direction of +∞.

=> 4

=> 3

math.sign(x)

Returns either a positive or negative 1, depending on the sign of x.

math.sqrt(x)

Square root of the given non-negative number

=> 10

math.trunc(x)

The integer part of the given number. Truncate towards zero.

Property

Description

Examples

math.E

Euler's number

=> 2.71828

math.LN10

Natural logarithm of 10

math.LN2

Natural logarithm of 2

math.LOG10E

Base 10 logarithm of e

math.LOG2E

Base 2 logarithm of e

math.PI

Pi, or the ratio of the circumference of a circle to its diameter

math.SQRT1_2

The square root of ½

math.SQRT2

The square root of 2

Function

Description

Examples

math.acos(x)

Arccosine (inverse cosine)

math.acosh(x)

Hyperbolic arccosine (inverse hyperbolic cosine)

math.asin(x)

Arcsine (inverse sine)

math.asinh(x)

Hyperbolic arcsine (inverse hyperbolic sine)

math.atan(x)

Arctangent (inverse tangent)

math.atan2(y, x)

2-agrument arctangent (2-argument inverse tangent)

the angle in the plane (in radians) between the positive x-axis and the ray from (0,0) to the point (x,y)

math.atanh(x)

Hyperbolic arctangent (inverse hyperbolic tangent)

math.cos(x)

Cosine

math.cosh(x)

Hyperbolic cosine

math.sin(x)

Sine

math.sinh(x)

Hyperbolic sine

math.tan(x)

Tangent

math.tanh(x)

Hyperbolic tangent

Function

Description

Examples

finance.FV(rate, nper, pmt[, pv, type])

Future value of an investment with periodic constant payments and a constant interest rate.

rate: interest rate per period

nper: number of periods for the lifetime of the annuity

pmt: payment amount per period

pv: present value of the annuity (if omitted, defaults to 0)

type: whether payments made at start or end of each period

0 = payments at end of period (default)

1 = payments at start of period

Future value of an investment of $1,000 per month for a period of 5 years. The present value is 0, interest rate is 5% per year and payments are made at the end of each month:

=> 68,006.08

Future value of an investment of $2,000 per quarter for a period of 4 years. The interest is 10% annually and payment are made at the start of the quarter:

=> 39,729.46

finance.NPER(rate, pmt, pv[, fv, type])

Number of periods

finance.PMT(rate, nper, pv[, fv, type])

Payment amount per period

finance.PV(rate, nper, pmt[, fv, type])

Present value of a loan or an investment, based on a constant interest rate.

rate: interest rate per period

nper: number of periods for the lifetime of the annuity

pmt: payment amount per period

fv: future value of the annuity (if omitted, defaults to 0)

type: whether payments made at start or end of each period

0 = payments at end of period (default)

1 = payments at start of period

Present value of an annuity that pays $1,000 per month for a period of 5 years. The interest is 5% annually and payments are made at the end of the month.

=> -52,990.71

Present value of an annuity of $2,000 per quarter for a period of 4 years. The interest is 10% per year and payments are made at the start of the quarter.

=> -26,762.76

finance.RATE(nper, pmt, pv[, fv, type, guess])

Interest rate per payment period

Filter

Description

Examples

format:string

Formats a date value into text.

Format strings are fully specified in date-fns' documentation:
https://date-fns.org/v2.8.1/docs/format

=>

else:text

=>

Method

Description

Examples

dateValue.getDate()

Extracts only the day (of the month) from dateValue.

Equivalent to date.dayOf().

=> 31

dateValue.getDay()

Returns the day of the week for dateValue, where 0 represents Sunday and 6 represents Saturday.

Equivalent to date.dayOfWeek().

=> 1

dateValue.getFullYear()

Extracts only the year from dateValue.

Equivalent to date.yearOf().

=> 2019

dateValue.getMonth()

Extracts only the month from dateValue.

NOTE: This returns a zero-based month, where 0 is January, 1 is February, … and 11 is December.

For 1-based months, either add one to the result, or see the date.monthOf() helper function.

=> 1

date1.isAfter(date2)

Tests whether date1 is after date2 chronologically.

Equivalent to date1 > date2 (?)

date1.isBefore(date2)

Tests whether date1 is before date2 chronologically.

Equivalent to date1 < date2 (?)

date1.isEqualTo(date2)

Tests whether date1 and date2 represent the same day.

Equivalent to date1 == date2 (?)

date1.isNotAfter(date2)

Tests whether date1 is NOT after date2 chronologically. In other words, date1 is no later than date2, or, date1 is before or on date2.

Equivalent to date1 <= date2 (?)

date1.isNotBefore(date2)

Tests whether date1 is NOT before date2 chronologically. In other words, date1 is no earlier than date2, or, date1 is on or after date2.

Equivalent to date1 >= date2 (?)

date1.isNotEqualTo(date2)

Tests whether date1 and date2 represent different days.

Equivalent to date1 != date2 (?)

dateValue.valueOf()

Returns an internal value representing the date, which is the number of milliseconds between 1 January 1970 and that date.

Function

Description

Examples

date.addDays(dateValue, d)

Returns the date a specified number d days after dateValue.

date 10 days after openingDate:

date.addMonths(dateValue, m)

Returns the date a specified number m months after dateValue.

date 3 months after startDate:

date.addWeeks(dateValue, w)

Returns the date a specified number w weeks after dateValue.

date 8 weeks after startDate:

date.addYears(dateValue, y)

Returns the date a specified number y years after dateValue.

date 2 years after startDate:

date.age(dateValue)

Calculates the number of whole years between dateValue and today.

=> 27

date.dayOf(dateValue)

Returns the day portion (day of the month) of dateValue in the form of a number between 1 and 31.

Equivalent to dateValue.getDate()

=> 25

date.dayOfWeek(dateValue)

Returns the day of the week for dateValue, where 0 represents Sunday and 6 represents Saturday.

Equivalent to dateValue.getDay()

date.daysBetween(date1, date2)

Returns the number of calendar days between date1 and date2.

date.monthOf(dateValue)

Returns the month portion of dateValue as a number between 1 (January) and 12 (December).

Note the difference in numbering with dateValue.getMonth()

date.monthsBetween(date1, date2)

Returns the number of full months between date1 and date2.

date.new(y, m, d)

Converts the given year, month (1-12) and day (1-31) numbers to a date value.

date.parse(textValue)

Attempts to parse the given textValue as a date, returning the resulting date value.

date.subDays(dateValue, d)

Returns the date a specified number d days before dateValue.

date 10 days before openingDate:

date.subMonths(dateValue, m)

Returns the date a specified number m months before dateValue.

date 3 months before startDate:

date.subWeeks(dateValue, w)

Returns the date a specified number w weeks before dateValue.

date 8 weeks before startDate:

date.subYears(dateValue, y)

Returns the date a specified number y years before dateValue.

date 2 years before startDate:

date.today()

Returns the current date in the local time zone.

(Note that the results of this function changes only when the formula is recalculated. It does not update continuously.)

date.yearOf(dateValue)

Returns the year portion of dateValue as a number between 1000 and 9999.

date.yearsBetween(date1, date2)

Returns the number of full years between date1 and date2.

Filter

Description

Examples

format:iftrue:iffalse

"Format" a true/false value as one of the provided text arguments.

Note: the conditional operator can do the same thing more concisely (coin ? "heads" : "tails"), so this is not very useful.

=> "heads"

Property

Description

Examples

length

The number of items in the list.

=> 4

Operator

Description

Examples

[ ]  

Extracts a single item from a list, where 0 retrieves the first item, 1 retrieves the second item, and so on.

=> the first child in the Children list

Filter

Description

Examples

any:expr

Produces a true/false value indicating whether the given expression (predicate) is true when evaluated against any item in the input list.

The filter stops evaluating as soon as it finds one item in the list where the expression evaluates to a truthy value.

This filter can also be used under the alias of some.

Do any children have a name that starts with C?

=> true

contains:value

Produces a true/false value indicating whether the given value exists in the input list.

Equivalent to the includes function.

Does a list of text values contain a specific text value?

=> false

every:expr

Produces a true/false value indicating whether the given expression (predicate) is true when evaluated against EVERY item in the input list.

The filter stops evaluating as soon as it finds one item in the list where the expression evaluates to a falsy value.

This filter can also be used under the alias of all.

Are all the children married?

=> false

filter:expr

Produces a filtered subset of the input list. The output list will contain every item from the input list where expr is true when evaluated against that item.

List all of the minor children:

find:expr

Produces a single value of the same type as the items in the input list. The given expression is evaluated against each item in the input list (in order). The first item where expr is true (or truthy) gets returned as the result of the find.

Get the party designated as executor:

group:expr

Produces a list of groups or categories from a flat input list.

The given expression (expr) is evaluated against each item in the input list. An output group is created for each unique result of that evaluation.

Each item in the output list (that is, each output group) is an object with two properties:

_key: the result of evaluating expr

_values: a list of the same type as the input list

List parties by relationship to the client:

map:expr

Produces a list of items where each item in the input list "maps" to exactly one item in the output list.

The given expression (expr) is evaluated against each item in the input list, and the result of that evaluation is placed in the output list.

Produce a list of names (simple text values) from a list of children:

punc[:example]

Specifies a punctuation style for the list to which it is applied. Only has an effect when used in a {[list]} field in a template.

Punctuation example strings consist of the digits (tokens) 1, 2, and optionally 3, separated by other characters as a way of indicating how items in this list should be joined together in text.

If no example is provided, "1, 2, and 3" is assumed.

Note: Unlike the rest of the list filters, this one outputs the same list that was passed into it.

=> John, Mary, Susan, and Edward

=> John and Edward

=> John, Mary, Susan, Edward.

=> John, Mary, Susan and Edward

=> Mary or Susan?

reduce:reducer[:initial]

Produces a new value by evaluating the given reducer expression against each item in the input list. Typically follows one of two models:

It can "reduce" the input list to a single value, such as when you want to calculate a value that requires some input from each item in the input list.

Or it can "accumulate" a new list as it goes through each item in the input list. Items in this new list need not have a 1:1 correspondence with the input items.

You can optionally specify an initial value for the output. For example, if the input list were empty, the output value would be whatever was specified as initial. If you do not specify an initial value, the first item in the input list becomes the initial value.

Reducer expressions have access to a special local variable called _result., which is of the same type as either the initial value or the first item in the input list. _result is always set to the result of the previous item's evaluation. Think of _result as a kind of bridge between the evaluation of each item in the input.

Sum a list of numbers:

Do the same thing as the map filter, mapping a list of Children to a list of their names:

Do the same thing as the filter filter, conditionally adding items to the result only if the child's age is <18:

Flatten a nested list. Each child has a list of toys, and each toy has a ToyName, but we need a flat list of ALL the toy names:

sort:key1[:key2…]

Changes the sort order of the list to which it is applied.

Sort keys are expressions relative to each item in the list. Expressions will be evaluated for each item in the list, and the result is used to determine the order of the resulting list.

Specifying a sort with multiple keys:

Descending (reversed) sort order uses a minus sign:

Sorting a list of text values (instead of objects):

Function

Description

Examples

listValue.concat(item1[, item2…])

Merges two or more lists. The concat method creates a list consisting of the items in the list on which it is called, followed in order by, for each argument, the items of that argument (if the argument is a list) or the argument itself (if the argument is not a list).

=> [1, 2, 3, 4, 5, 6, 7, 8]

listValue.includes(item[, start])

Determines whether a list includes a certain item among its entries, returning true or false as appropriate.

If start is specified, it ignores any items in the list prior to that index.

Equivalent to the contains filter.

listValue.indexOf(item[, start])

Returns the first index at which a given item can be found in the list, or -1 if it is not present.

listValue.join([separator])

Creates and returns a text value by concatenating all the items in a list of text values, separated by a specified separator value.

If no separator is provided, an unspaced comma (",") will be used.

If the list has only one text value, that value will be returned without using the separator.

If the list contains items other than text values, they will be coerced to text and you'll probably get something ugly.

listValue.lastIndexOf(item[, start])

Returns the last index at which a given item can be found in the list, or -1 if it is not present.

listValue.slice([begin[, end]])

Extracts a portion of a list from begin (inclusive) to end (exclusive) where begin and end represent zero-based indices of items in the list.

begin: Index at which to begin extraction. A negative index can be used, indicating an offset from the end of the list.  If begin is omitted, slice begins from index 0. If begin is greater than the length of the list, an empty list is returned.

end: Index before which to end extraction. A negative index can be used, indicating an offset from the end of the list. If end is omitted or is greater than the length of the list, slice extracts through the end of the list.