json.encode - Real Function Reference

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

Argumente

any

erforderlich

Value, der encoded wird. nil, booleans, numbers, strings, tables und json.null werden direkt behandelt. Unsupported Lua types werden als null encoded, ausser errorOnUnsupported ist true.

EncodeOptions

Optional encode options. Ein boolean toggelt pretty output. Eine number aktiviert pretty output mit so vielen spaces, geclamped auf 0.16. Ein string aktiviert pretty output mit diesem indent. Eine table kann pretty, sortKeys, emptyTableAsArray, errorOnUnsupported, encodeInvalidNumbersAsNull, maxDepth und indent setzen.

Rückgaben

string

Encoded JSON string. Encoding errors werden als Luau errors geworfen.

Typen

EncodeOptions

Steuert die JSON-Serialisierung und -Formatierung.

Name	Type	Required	Beschreibung
`pretty`	`boolean`	No	Ermöglicht eine formatierte, mehrzeilige JSON-Ausgabe.
`sortKeys`	`boolean`	No	Sortiert Objektschlüssel vor der Codierung.
`emptyTableAsArray`	`boolean`	No	Kodiert eine leere Tabelle als Array statt als Objekt.
`errorOnUnsupported`	`boolean`	No	Löst einen Fehler aus, anstatt nicht unterstützte Werte zu ersetzen.
`encodeInvalidNumbersAsNull`	`boolean`	No	Kodiert NaN und unendliche Zahlen als JSON-Null.
`maxDepth`	`integer`	No	Legt die maximale Verschachtelungstiefe fest, geklemmt von 1 bis 4096.
`indent`	`string`	No	Legt die Einrückungszeichenfolge fest, begrenzt auf 32 Zeichen.

Beispiel

Encode JSON-compatible values und nutze json.array, wenn ein empty array ein array bleiben muss.

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

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

print(text)

​Argumente

​Rückgaben

​Typen

​EncodeOptions

​Beispiel

Argumente

Rückgaben

Typen

EncodeOptions

Beispiel