json.encode - Real Function Reference

json.encode(value: any, options?: EncodeOptions): string

Argumentos

any

obrigatório

Value para encode. nil, booleans, numbers, strings, tables e json.null sao tratados diretamente. Unsupported Lua types sao encode como null, a menos que errorOnUnsupported seja true.

EncodeOptions

Optional encode options. Um boolean alterna pretty output. Um number ativa pretty output com essa quantidade de spaces clamped para 0.16. Um string ativa pretty output com esse indent. Uma table pode definir pretty, sortKeys, emptyTableAsArray, errorOnUnsupported, encodeInvalidNumbersAsNull, maxDepth e indent.

Retornos

string

Encoded JSON string. Encoding errors sao lancados como Luau errors.

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 usando json.array quando um empty array deve continuar array.

local payload = {
    name = "Real",
    enabled = true,
    tags = json.array({ "api", "docs" }),
    missing = json.null,
}

local text = json.encode(payload, {
    sortKeys = true,
})

print(text)

​Argumentos

​Retornos

​Tipos

​EncodeOptions

​Exemplo

Argumentos

Retornos

Tipos

EncodeOptions

Exemplo