> ## 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.encodePretty

> Serializa um Lua value para um JSON string legivel e formatado usando Real JSON encoder. json.pretty e registrado na mesma function.

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

  ## Argumentos

  <ParamField path={"value"} type={"any"} required>
    Value que sera encoded. nil, booleans, numbers, strings, tables e json.null sao tratados diretamente. Unsupported Lua types sao encoded como null, a menos que errorOnUnsupported seja true.
  </ParamField>

  <ParamField path={"options"} type={"EncodeOptions"}>
    Optional encode options. json.encodePretty le as mesmas options que json.encode e depois força pretty para true. Sem options, usa um two-space indent. Um number define a indent width com clamp para 0.16, uma string define o indent text, e uma table pode definir sortKeys, emptyTableAsArray, errorOnUnsupported, encodeInvalidNumbersAsNull, maxDepth e indent.
  </ParamField>

  ## Retornos

  <ResponseField name={"json"} type={"string"}>
    Readable formatted JSON string. Encoding errors sao lancados como Luau errors.
  </ResponseField>

  ## Tipos

  ### EncodeOptions

  Controla a serialização e formatação JSON.

  | Name                         | Type      | Required | Descrição                                                        |
  | ---------------------------- | --------- | -------- | ---------------------------------------------------------------- |
  | `pretty`                     | `boolean` | No       | Permite saída JSON formatada e multilinha.                       |
  | `sortKeys`                   | `boolean` | No       | Classifica as chaves dos objetos antes da codificação.           |
  | `emptyTableAsArray`          | `boolean` | No       | Codifica uma tabela vazia como uma matriz em vez de um objeto.   |
  | `errorOnUnsupported`         | `boolean` | No       | Gera um erro em vez de substituir valores não suportados.        |
  | `encodeInvalidNumbersAsNull` | `boolean` | No       | Codifica NaN e números infinitos como JSON nulo.                 |
  | `maxDepth`                   | `integer` | No       | Define a profundidade máxima de aninhamento, fixada de 1 a 4096. |
  | `indent`                     | `string`  | No       | Define a sequência de recuo, limitada a 32 caracteres.           |

  ## Exemplo

  Encode JSON-compatible values como readable formatted JSON com pretty output forced on.

  ```lua theme={null}
  local text = json.encodePretty({
      name = "Real",
      version = 1,
      features = json.array({ "docs", "examples" }),
      missing = json.null,
  }, {
      sortKeys = true,
  })

  print(text)
  ```
</div>