> ## Documentation Index
> Fetch the complete documentation index at: https://docs.projectreal.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# json.pretty

> Serialise un Lua value en readable formatted JSON string avec la meme function que json.encodePretty.

<div className="real-function-page">
  ```lua theme={null}
  json.pretty(value: any, options?: EncodeOptions): string
  ```

  ## Arguments

  <ParamField path={"value"} type={"any"} required>
    Value a encoder. nil, booleans, numbers, strings, tables et json.null sont geres directement. Unsupported Lua types sont encoded en null sauf si errorOnUnsupported vaut true.
  </ParamField>

  <ParamField path={"options"} type={"EncodeOptions"}>
    Optional encode options. json.pretty lit les memes options que json.encodePretty, puis force pretty a true. Sans options, il utilise un two-space indent. Un number definit la indent width avec clamp a 0.16, un string definit le indent text, et une table peut definir sortKeys, emptyTableAsArray, errorOnUnsupported, encodeInvalidNumbersAsNull, maxDepth et indent.
  </ParamField>

  ## Retours

  <ResponseField name={"json"} type={"string"}>
    Readable formatted JSON string. Encoding errors sont lancees comme Luau errors.
  </ResponseField>

  ## Types

  ### EncodeOptions

  Contrôle la sérialisation et le formatage JSON.

  | Name                         | Type      | Required | Description                                                              |
  | ---------------------------- | --------- | -------- | ------------------------------------------------------------------------ |
  | `pretty`                     | `boolean` | No       | Permet une sortie JSON formatée et multiligne.                           |
  | `sortKeys`                   | `boolean` | No       | Trie les clés d'objet avant l'encodage.                                  |
  | `emptyTableAsArray`          | `boolean` | No       | Encode une table vide sous forme de tableau au lieu d'un objet.          |
  | `errorOnUnsupported`         | `boolean` | No       | Génère une erreur au lieu de remplacer des valeurs non prises en charge. |
  | `encodeInvalidNumbersAsNull` | `boolean` | No       | Encode NaN et les nombres infinis en JSON null.                          |
  | `maxDepth`                   | `integer` | No       | Définit la profondeur d'imbrication maximale, comprise entre 1 et 4 096. |
  | `indent`                     | `string`  | No       | Définit la chaîne d'indentation, limitée à 32 caractères.                |

  ## Exemple

  Encode JSON-compatible values en readable formatted JSON avec le json.encodePretty alias.

  ```lua theme={null}
  local text = json.pretty({
      category = "JSON",
      tags = json.array({ "pretty", "alias" }),
      missing = json.null,
  }, {
      sortKeys = true,
  })

  print(text)
  ```
</div>