json.encodePretty - Real Function Reference

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

Arguments

any

requis

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.

EncodeOptions

Optional encode options. json.encodePretty lit les memes options que json.encode, 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.

Retours

string

JSON string formate et lisible. Encoding errors sont lancees comme Luau errors.

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 pretty output forced on.

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

print(text)

​Arguments

​Retours

​Types

​EncodeOptions

​Exemple

Arguments

Retours

Types

EncodeOptions

Exemple