json.encode

Real JSON encoder を使って Lua value を JSON string に serialize します。json.stringify は同じ function に登録されています。

構文

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

引数

Name	Type	Required	説明
`value`	`any`	Yes	encode される Value。nil、booleans、numbers、strings、tables、json.null は直接処理されます。Unsupported Lua types は errorOnUnsupported が true でない限り null として encode されます。
`options`	`EncodeOptions`	No	Optional encode options。boolean は pretty output を切り替えます。number は 0.16 に clamp された数の spaces で pretty output を有効にします。string はその indent で pretty output を有効にします。table は pretty、sortKeys、emptyTableAsArray、errorOnUnsupported、encodeInvalidNumbersAsNull、maxDepth、indent を設定できます。

戻り値

Name	Type	説明
`json`	`string`	Encoded JSON string。Encoding errors は Luau errors として throw されます。

型

EncodeOptions

JSON のシリアル化とフォーマットを制御します。

Name	Type	Required	説明
`pretty`	`boolean`	No	フォーマットされた複数行の JSON 出力を有効にします。
`sortKeys`	`boolean`	No	エンコード前にオブジェクトキーをソートします。
`emptyTableAsArray`	`boolean`	No	空のテーブルをオブジェクトではなく配列としてエンコードします。
`errorOnUnsupported`	`boolean`	No	サポートされていない値を置き換えるのではなく、エラーを発生させます。
`encodeInvalidNumbersAsNull`	`boolean`	No	NaN と無限数を JSON null としてエンコードします。
`maxDepth`	`integer`	No	ネストの最大の深さを 1 ～ 4096 の範囲で設定します。
`indent`	`string`	No	インデント文字列を設定します。32 文字に制限されます。

例

JSON-compatible values を encode し、empty array を array のままにする必要がある場合は json.array を使います。

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

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

print(text)

⌘I

Overview

Cache

Cryptography

Filesystem

JSON

Console

Drawing

ImGui

Input

Instances

Reflection

Scripts

Signals

WebSocket

Actors

Closures

Debug

Environment

Metatables

Threads

Disassembler

Miscellaneous

RakNet

RealSignal

SaveInstance

構文

引数

戻り値

型

EncodeOptions

例

​構文

​引数

​戻り値

​型

​EncodeOptions

​例

構文

引数

戻り値

型

EncodeOptions

例