{"route":"/en-US-v0.14.1/reference/data-loading/json/","title":"JSON","description":"Documentation for the `json` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"conversion","name":"Conversion","children":[{"id":"notes","name":"Notes","children":[]}]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-source","name":"source","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-decode","name":"Decode JSON","children":[{"id":"definitions-decode-data","name":"data","children":[]}]},{"id":"definitions-encode","name":"Encode JSON","children":[{"id":"definitions-encode-value","name":"value","children":[]},{"id":"definitions-encode-pretty","name":"pretty","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"json","title":"JSON","keywords":[],"oneliner":"Reads structured data from a JSON file.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Reads structured data from a JSON file.

\n

The file must contain a valid JSON value, such as object or array. The JSON\nvalues will be converted into corresponding Typst values as listed in the\ntable below.

\n

The function returns a dictionary, an array or, depending on the JSON file,\nanother JSON data type.

\n

The JSON files in the example contain objects with the keys temperature,\nunit, and weather.

\n

Example

\n
#let forecast(day) = block[\n  #box(square(\n    width: 2cm,\n    inset: 8pt,\n    fill: if day.weather == "sunny" {\n      yellow\n    } else {\n      aqua\n    },\n    align(\n      bottom + right,\n      strong(day.weather),\n    ),\n  ))\n  #h(6pt)\n  #set text(22pt, baseline: -8pt)\n  #day.temperature °#day.unit\n]\n\n#forecast(json("monday.json"))\n#forecast(json("tuesday.json"))\n
\"Preview\"
\n

Conversion details

\n\n\n\n\n\n\n\n
JSON valueConverted into Typst
nullnone
boolbool
numberfloat or int
stringstr
arrayarray
objectdictionary
\n\n\n\n\n\n\n
Typst valueConverted into JSON
types that can be converted from JSONcorresponding JSON value
bytesstring via repr
symbolstring
contentan object describing the content
other types (length, etc.)string via repr
\n

Notes

\n"}],"self":false,"params":[{"name":"source","details":[{"kind":"html","content":"

A path to a JSON file or raw JSON bytes.

"}],"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[{"path":["json"],"name":"decode","title":"Decode JSON","keywords":[],"oneliner":"Reads structured data from a JSON string/bytes.","element":false,"contextual":false,"deprecationMessage":"`json.decode` is deprecated, directly pass bytes to `json` instead","deprecationUntil":"0.15.0","details":[{"kind":"html","content":"

Reads structured data from a JSON string/bytes.

"}],"self":false,"params":[{"name":"data","details":[{"kind":"html","content":"

JSON data.

"}],"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["json"],"name":"encode","title":"Encode JSON","keywords":[],"oneliner":"Encodes structured data into a JSON string.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Encodes structured data into a JSON string.

"}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

Value to be encoded.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"pretty","details":[{"kind":"html","content":"

Whether to pretty print the JSON with newlines and indentation.

"}],"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["str"],"scope":[]}]}}}