--- layout: default ---
This page describes the functions available in Jsonnet's standard library, i.e. the object
implicitly bound to the std
variable. Some of the standard library functions can be
implemented in Jsonnet. Their code can be found in the std.jsonnet file. The behavior of
some of the other functions, i.e. the ones that expose extra functionality not otherwise available
to programmers, is described formally in the specification.
The standard library is implicitly added to all Jsonnet programs by enclosing them in a local
construct. For example, if the program given by the user is {x: "foo"}
, then the
actual code executed would be local std = { ... }; {x: "foo"}
. The functions in the
standard library are all hidden fields of the std
object.
If an external variable with the given name was defined, return its string value. Otherwise, raise an error.
Note that this is a field. It contains the current Jsonnet filename as a string.
Return a string that indicates the type of the value. The possible return values are: "array", "boolean", "function", "null", "number", "object", and "string".
The following functions are also available and return a boolean:
std.isArray(v)
,
std.isBoolean(v)
,
std.isFunction(v)
,
std.isNumber(v)
,
std.isObject(v)
, and
std.isString(v)
.
Depending on the type of the value given, either returns the number of elements in the array,
the number of codepoints in the string, the number of parameters in the function, or the number of
fields in the object. Raises an error if given a primitive value, i.e. null
,
true
or false
.
Returns true
if the given object has the field (given as a string), otherwise
false
. Raises an error if the arguments are not object and string respectively.
Returns false if the field is hidden..
Returns an array of strings, each element being a field from the given object. Does not include hidden fields.
As std.objectHas
but also includes hidden fields.
As std.objectFields
but also includes hidden fields.
Recursively remove all "empty" members of `x`. "Empty" is defined as zero length `arrays`, zero length `objects`, or `null` values.
Apply the given function to all fields of the given object, also passing
the field name. The function func
is expected to take the
field name as the first parameter and the field value as the second.
The following mathematical functions are available:
std.abs(n)
,
std.sign(n)
,
std.max(a, b)
,
std.min(a, b)
,
std.pow(x, n)
,
std.exp(x)
,
std.log(x)
,
std.exponent(x)
,
std.mantissa(x)
,
std.floor(x)
,
std.ceil(x)
,
std.sqrt(x)
,
std.sin(x)
,
std.cos(x)
,
std.tan(x)
,
std.asin(x)
,
std.acos(x)
, and
std.atan(x)
.
The function std.mod(a, b)
is what the % operator is desugared to. It performs
modulo arithmetic if the left hand side is a number, or if the left hand side is a string, it does
Python-style string formatting with std.format()
.
Ensure that a == b
. Returns true
or throws an error message.
Convert the given argument to a string.
Returns the positive integer representing the unicode codepoint of the character in the given
single-character string. This function is the inverse of std.char(n)
.
Returns a string of length one whose only unicode codepoint has integer id n
. This function is the inverse of std.codepoint(str)
.
Returns a string that is the part of s
that starts at offset from
and
is len
codepoints long.
Returns whether the string a is prefixed by the string b.
Returns whether the string a is suffixed by the string b.
Returns a string that is the part of s
that starts at offset from
and
is len
codepoints long.
Split the string str
into an array of strings, divided by the single character
c
.
Example: std.split("foo/bar", "/")
yields ["foo", "bar"]
.
Example: std.split("/foo/", "/")
yields ["", "foo", ""]
.
As std.split(str, c) but will stop after maxsplits
splits, thereby the largest array
it will return has length maxsplits + 1
. A limit of -1 means unlimited.
Example: std.splitLimit("foo/bar", "/", 1)
yields ["foo", "bar"]
.
Example: std.splitLimit("/foo/", "/", 1)
yields ["", "foo/"]
.
Returns a copy of the string in which all occurrences of string from
have been replaced
with string to
Example: std.strReplace('I like to skate with my skateboard', 'skate', 'surf')
yields "I like to surf with my surfboard"
.
Returns a copy of the string in which all ASCII letters are capitalized.
Example: std.asciiUpper('100 Cats!')
yields "100 CATS!"
.
Returns a copy of the string in which all ASCII letters are lower cased.
Example: std.asciiLower('100 Cats!')
yields "100 cats!"
.
Split the string str
into an array of strings, each containing a single
codepoint.
Example: std.stringChars("foo")
yields ["f", "o", "o"]
.
Format the string str
using the values in vals
. The values can be an
array, an object, or in other cases are treated as if they were provided in a singleton array. The
string formatting follows the same rules as Python.
The %
operator can be used as a shorthand for this function.
Example: std.format("Hello %03d", 12)
yields "Hello 012"
.
Example: "Hello %03d" % 12
yields "Hello 012"
.
Example: "Hello %s, age %d" % ["Foo", 25]
yields "Hello Foo, age 25"
.
Example: "Hello %(name)s, age %(age)d" % {age: 25, name: "Foo"}
yields
"Hello Foo, age 25"
.
Parses a signed decimal integer from the input string
Example: std.parseInt("123")
yields 123
.
Example: std.parseInt("-123")
yields -123
.
Wrap str
in single quotes, and escape any single quotes within str
by
changing them to a sequence '"'"'. This allows injection of arbitrary strings as arguments
of commands in bash scripts.
Convert $ to $$ in str
. This allows injection of arbitrary strings into systems
that use $ for string interpolation (like Terraform).
Convert str
to allow it to be embedded in a JSON representation, within a string. This adds quotes, escapes backslashes, and escapes unprintable characters.
Example:
{
local description = "Multiline\nc:\\path",
json: "{name: %s}" % std.escapeStringJson(description)
}
yields: {"json": "{name: \"Multiline\\nc:\\\\path\"}"}
Convert str
to allow it to be embedded in Python. This is an alias for std.escapeStringJson.
Convert the given structure to a string in INI format. This allows using Jsonnet's object model to build a configuration to be consumed by an application expecting an INI file. The data is in the form of a set of sections, each containing a key/value mapping. These examples should make it clear:
{
main: { a: "1", b: "2" },
sections: {
s1: {x: "11", y: "22", z: "33"},
s2: {p: "yes", q: ""},
empty: {},
}
}
Yields a string containing this INI file:
a = 1
b = 2
[empty]
[s1]
x = 11
y = 22
z = 33
[s2]
p = yes
q =
Convert the given value to a JSON-like form that is compatible with Python. The chief differences are True / False / None instead of true / false / null.
{
b: ["foo", "bar"],
c: true,
d: null,
e: { f1: false, f2: 42 },
}
Yields a string containing this Python code:
{"b": ["foo", "bar"], "c": True, "d": None, "e": {"f1": False, "f2": 42}}
Convert the given object to a JSON-like form that is compatible with Python. The key
difference to std.manifestPython
is that the top level is represented as a list of
Python global variables.
{
b: ["foo", "bar"],
c: true,
d: null,
e: { f1: false, f2: 42 },
}
Yields a string containing this Python code:
b = ["foo", "bar"]
c = True
d = None
e = {"f1": False, "f2": 42}
Convert the given object to a JSON form. indent
is a string containing
one or more whitespaces that are used for indentation:
std.manifestJsonEx(
{
x: [1, 2, 3, true, false, null, "string\nstring"],
y: { a: 1, b: 2, c: [1, 2] },
}, " ")
Yields a string containing this JSON object:
{
"x": [
1,
2,
3,
true,
false,
null,
"string\nstring"
],
"y": {
"a": 1,
"b": 2,
"c": [
1,
2
]
}
}
Convert the given value to a YAML form. Note that std.manifestJson
could also be
used for this purpose, because any JSON is also valid YAML. But this function will produce more
canonical-looking YAML.
std.manifestYamlDoc(
{
x: [1, 2, 3, true, false, null, "string\nstring\n"],
y: { a: 1, b: 2, c: [1, 2] },
})
Yields a string containing this YAML:
"x":
- 1
- 2
- 3
- true
- false
- null
- |
string
string
"y":
"a": 1
"b": 2
"c":
- 1
- 2
Given an array of values, emit a YAML "stream", which is a sequence of documents separated by
---
.
std.manifestYamlStream(['a', 1, []])
Yields this string:
---
"a"
---
1
---
[]
...
Convert the given JsonML-encoded value to a string containing the XML.
std.manifestXmlJsonml([
'svg',
{ height: 100, width: 100 },
['circle', { cx: 50, cy: 50, r: 40, stroke: 'black', 'stroke-width': 3, fill: 'red' }],
])
Yields a string containing this XML (all on one line):
<svg height="100" width="100">
<circle cx="50" cy="50" fill="red" r="40" stroke="black" stroke-width="3"></circle>
</svg>
Which represents the following image:
JsonML is designed to preserve "mixed-mode content" (i.e., textual data outside of or next to elements). This includes the whitespace needed to avoid having all the XML on one line, which is meaningful in XML. In order to have whitespace in the XML output, it must be present in the JsonML input:
std.manifestXmlJsonml([
'svg',
{ height: 100, width: 100 },
'\n ',
['circle', { cx: 50, cy: 50, r: 40, stroke: 'black', 'stroke-width': 3, fill: 'red' }],
'\n',
])
Create a new array of sz
elements by calling func(i)
to initialize each
element. Func is expected to be a function that takes a single parameter, the index of the element
it should initialize.
Example: std.makeArray(3,function(x) x * x)
yields [0, 1, 4]
.
Return the number of times that x occurs in arr.
Apply the given function to every element of the array to form a new array.
Similar to map above, but it also passes to the
function the element's index in the array. The function func
is expected to take the index as the first parameter and the element as the
second.
This is primarily used to desugar array comprehension syntax. It first filters, then maps thte given array, using the two functions provided.
Return a new array containing all the elements of arr
for which the
func
function returns true.
Classic foldl function. Calls the function on the result of the previous function call and each
array element, or init
in the case of the initial element. Traverses the array from
left to right.
Classic foldl function. Calls the function on each array element and the result of the previous
function call, or init
in the case of the initial element. Traverses the array from
right to left.
Return an array of ascending numbers between the two limits, inclusively.
If sep
is a string, then arr
must be an array of strings, in which case
they are concatenated with sep
used as a delimiter. If sep
is an array,
then arr
must be an array of arrays, in which case the arrays are concatenated in the
same way, to produce a single array.
Example1: std.join(".", ["www", "google", "com"])
yields
"www.google.com"
.
Example2: std.join([9, 9], [[1], [2, 3]])
yields [1, 9, 9, 2, 3]
.
Concatenate an array of strings into a text file with newline characters after each string. This is suitable for constructing bash scripts and the like.
Concatenate an array of arrays into a single array.
Sorts the array using the <= operator.
Removes successive duplicates. When given a sorted array, removes all duplicates.
Syntax sugar for std.uniq(std.sort(arr)).
Set intersection operation (values in both a and b).
Set union operation (values in either a or b). Note that + on sets will simply concatenate the arrays, possibly forming an array that is not a set (due to not bein ordered without duplicates).
Set difference operation (values in a but not b).
Returns true
if x is a member of array, otherwise false
.
Encodes the given value into a base64 string. The encoding sequence is A-Za-z0-9+/ with = to pad the output to a multiple of 4 characters. The value can be a string or an array of numbers, but the codepoints / numbers must be in the 0 to 255 range. The resulting string has no line breaks.
Decodes the given base64 string into an array of bytes (number values). Currently assumes the input string has no linebreaks and is padded to a multiple of 4 (with the = character). In other words, it consumes the output of std.base64().
Behaves like std.base64DecodeBytes() except returns a string instead of an array of bytes.
Encodes the given value into an MD5 string.
Applies patch
to target
according to RFC7396