{"route":"/en-US-v0.13.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":"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,"deprecation":null,"details":"

Reads structured data from a JSON file.

\n

The file must contain a valid JSON value, such as object or array. JSON\nobjects will be converted into Typst dictionaries, and JSON arrays will be\nconverted into Typst arrays. Strings and booleans will be converted into the\nTypst equivalents, null will be converted into none, and numbers will\nbe converted to floats or integers depending on whether they are whole\nnumbers.

\n

Be aware that integers larger than 263-1 will be converted to\nfloating point numbers, which may result in an approximative value.

\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\"
","example":null,"self":false,"params":[{"name":"source","details":"

A path to a JSON file or raw JSON bytes.

","example":null,"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,"deprecation":"`json.decode` is deprecated, directly pass bytes to `json` instead","details":"

Reads structured data from a JSON string/bytes.

","example":null,"self":false,"params":[{"name":"data","details":"

JSON data.

","example":null,"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,"deprecation":null,"details":"

Encodes structured data into a JSON string.

","example":null,"self":false,"params":[{"name":"value","details":"

Value to be encoded.

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

Whether to pretty print the JSON with newlines and indentation.

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