Documentação Real

Sintaxe

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

Argumentos

Nome	Tipo	Descrição
`value`	`any`	Novo valor para escrever.
`options?`	`EncodeOptions`	Tabela de configurações opcionais que controla como a operação se comporta.

Retornos

Nome	Tipo	Descrição
`json`	`string`	Resultado da sequência JSON.

Descrição

Serializa um valor Luau em JSON usando regras opcionais de formatação e codificação.

Chame com 2 parametro(s): value, options. A tabela de argumentos explica quais valores sao obrigatorios e quais refinam o comportamento.

Retorna json (string). Use a tabela de retornos para separar valores bem sucedidos, nil e erros recuperaveis.

Exemplo

Codifique uma tabela como JSON formatado com ordem de chave estável.

local payload = {
    name = "Real",
    enabled = true,
    tags = { "api", "docs" },
}

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

print(text)

Tipos

EncodeOptions

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

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