From fc5bc2582df00fa13ba7b60440c4fba437e4bc35 Mon Sep 17 00:00:00 2001 From: lixianjing Date: Wed, 13 Jan 2021 15:49:25 +0800 Subject: [PATCH] improve docs --- docs/changes.md | 1 + docs/fscript_json.md | 45 +++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 45 insertions(+), 1 deletion(-) diff --git a/docs/changes.md b/docs/changes.md index 20b94a27e..7ef4f6aa0 100644 --- a/docs/changes.md +++ b/docs/changes.md @@ -3,6 +3,7 @@ 2021/01/13 * 完善 fscript.md。 * 完善 api 注释(感谢福明提供补丁) + * 增加 [《JSON 扩展模块》](fscript_json.md) * 增加 [《文件系统扩展模块》](fscript_fs.md) * 增加 [《日期和时间扩展模块》](fscript_date_time.md) * 修复 tkc/event.c/event.h 中的错误(感谢忠吉提供补丁) diff --git a/docs/fscript_json.md b/docs/fscript_json.md index d4e58ca29..348e3f091 100644 --- a/docs/fscript_json.md +++ b/docs/fscript_json.md @@ -1,10 +1,54 @@ ## JSON 扩展函数 ### 1.json\_load + +> 加载 json 数据。 +---------------------------- + +#### 原型 + +```js +json_load(str) => object +json_load(binary) => object +json_load(data, size) => object +``` + ### 2.json\_save + +> 保存 json 数据。 +---------------------------- + +#### 原型 + +```js +json_save(obj, filename) => bool +``` + ### 3.ubjson\_load + +> 加载 ubjson 数据。 +---------------------------- + +#### 原型 + +```js +ubjson_load(binary) => object +ubjson_load(data, size) => object +``` + ### 4.ubjson\_save +> 保存 ubjson 数据。 +---------------------------- + +#### 原型 + +```js +ubjson_save(obj, filename) => bool +``` + +### 完整示例 + ```js //load from string a=json_load(' @@ -38,4 +82,3 @@ assert(file_remove("test.json")) unset(a) unset(b) ``` -