json.format - Real Function Reference

json.format(json: string, encodeOptions?: EncodeOptions, decodeOptions?: DecodeOptions): string

Argumente

string

erforderlich

JSON string, der vor dem formatting parsed wird. Die function liest dieses argument mit string type checking.

EncodeOptions

Optional encode options fuer den re-encode step. json.format liest dieselben encode options wie json.encode und setzt danach pretty auf true.

DecodeOptions

Optional decode options fuer das parsing des input JSON. Ein boolean setzt useNull. Eine table kann useNull und maxDepth setzen.

Rückgaben

string

Readable formatted JSON string, der nach parsing und re-encoding des input erzeugt wird.

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.

DecodeOptions

Steuert das JSON-Parsing-Verhalten.

Name	Type	Required	Beschreibung
`useNull`	`boolean`	No	Stellt JSON Null mit dem Null-Sentinel der Bibliothek anstelle von Null dar.
`maxDepth`	`integer`	No	Legt die maximale Verschachtelungstiefe fest, geklemmt von 1 bis 4096.

Beispiel

Parse existing JSON und re-encode es als readable formatted JSON.

local compact = '{"b":2,"a":1}'
local formatted = json.format(compact, {
    pretty = true,
    sortKeys = true,
}, {
    useNull = true,
})

print(formatted)

​Argumente

​Rückgaben

​Typen

​EncodeOptions

​DecodeOptions

​Beispiel

Argumente

Rückgaben

Typen

EncodeOptions

DecodeOptions

Beispiel