✨ feat(tsl-api-reference): expand API and module coverage
This commit is contained in:
@@ -6,22 +6,22 @@
|
||||
|
||||
用于读取和写入 INI 配置文件的内置对象
|
||||
|
||||
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
|
||||
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database 创建 生成 构造函数 实例化 new -->
|
||||
|
||||
### `create(alias, file_name)`
|
||||
|
||||
声明:function
|
||||
|
||||
创建 TIniFile 实例
|
||||
构造函数。打开指定目录别名和文件名对应的 INI 配置
|
||||
|
||||
<!-- tags: Object TIniFile INI 文件 创建 生成 目录 路径 file 数据库 SQL database -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `alias` | string | 目录别名 |
|
||||
| `file_name` | string | INI文件名 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ------ | ---------- |
|
||||
| `alias` | string | 目录别名 |
|
||||
| `file_name` | string | INI 文件名 |
|
||||
|
||||
### `deleteKey(section, ident)`
|
||||
|
||||
@@ -33,10 +33,10 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | -------------------------------- |
|
||||
| `section` | string | 字符串类型,要删除的键所在章节名 |
|
||||
| `ident` | string | 字符串类型,要删除的键名 |
|
||||
| `ident` | string | 字符串类型,要删除的键名 |
|
||||
|
||||
返回:any
|
||||
|
||||
@@ -50,8 +50,8 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | -------------------------- |
|
||||
| `section` | string | 字符串类型,要删除的章节名 |
|
||||
|
||||
返回:any
|
||||
@@ -66,15 +66,15 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | TStream | TStream类型,存贮读取的内容 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------- | --------------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | TStream | TStream类型,存贮读取的内容 |
|
||||
|
||||
返回:integer
|
||||
|
||||
### `readBoolean(section, ident, default)`
|
||||
### `readBool(section, ident, default)`
|
||||
|
||||
声明:function
|
||||
|
||||
@@ -84,10 +84,10 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------- | ----------------------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `default` | boolean | Boolean类型,当不存在的时候的默认值 |
|
||||
|
||||
返回:boolean
|
||||
@@ -102,11 +102,11 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `default` | TDate | 日期类型,当不存在的时候的默认值 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | -------------------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `default` | TDate | 日期类型,当不存在的时候的默认值 |
|
||||
|
||||
返回:TDate
|
||||
|
||||
@@ -120,10 +120,10 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `default` | datetime | 日期时间类型,当不存在的时候的默认值 |
|
||||
|
||||
返回:datetime
|
||||
@@ -138,11 +138,11 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `default` | float | 实数类型,当不存在的时候的默认值 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | -------------------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `default` | float | 实数类型,当不存在的时候的默认值 |
|
||||
|
||||
返回:float
|
||||
|
||||
@@ -156,10 +156,10 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------- | -------------------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `default` | integer | 整数类型,当不存在的时候的默认值 |
|
||||
|
||||
返回:integer
|
||||
@@ -174,9 +174,9 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ----------- | ------------------------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `strings` | TStringList | TStringList类型,用于存贮章节里的键名 |
|
||||
|
||||
返回:any
|
||||
@@ -191,8 +191,8 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ----------- | ----------------------------- |
|
||||
| `strings` | TStringList | TStringList类型,用于存贮章名 |
|
||||
|
||||
返回:any
|
||||
@@ -207,9 +207,9 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ----------- | ------------------------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `strings` | TStringList | TStringList类型,用于存贮章节里的内容 |
|
||||
|
||||
返回:any
|
||||
@@ -224,10 +224,10 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | ---------------------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `default` | string | 字符串类型,当不存在的时候的默认值 |
|
||||
|
||||
返回:string
|
||||
@@ -242,8 +242,8 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | ---------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
|
||||
返回:boolean
|
||||
@@ -258,10 +258,10 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | -------------------------------- |
|
||||
| `section` | string | 字符串类型,要查找的键所在章节名 |
|
||||
| `ident` | string | 字符串类型,要查找的键名 |
|
||||
| `ident` | string | 字符串类型,要查找的键名 |
|
||||
|
||||
返回:boolean
|
||||
|
||||
@@ -275,15 +275,15 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | TStream | TStream类型,值内容 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------- | ------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | TStream | TStream类型,值内容 |
|
||||
|
||||
返回:any
|
||||
|
||||
### `writeBoolean(section, ident, value)`
|
||||
### `writeBool(section, ident, value)`
|
||||
|
||||
声明:function
|
||||
|
||||
@@ -293,11 +293,11 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | boolean | Boolean类型,值内容 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------- | ------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | boolean | Boolean类型,值内容 |
|
||||
|
||||
返回:any
|
||||
|
||||
@@ -311,11 +311,11 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | TDate | 日期类型,值内容 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | ------------------ |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | TDate | 日期类型,值内容 |
|
||||
|
||||
返回:any
|
||||
|
||||
@@ -329,11 +329,11 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | datetime | 日期时间类型,值内容 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | -------- | -------------------- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | datetime | 日期时间类型,值内容 |
|
||||
|
||||
返回:any
|
||||
|
||||
@@ -347,11 +347,11 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | float | 实数类型,值内容 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | ------------------ |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | float | 实数类型,值内容 |
|
||||
|
||||
返回:any
|
||||
|
||||
@@ -365,11 +365,11 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | integer | 整数类型,值内容 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------- | ------------------ |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | integer | 整数类型,值内容 |
|
||||
|
||||
返回:any
|
||||
|
||||
@@ -383,10 +383,10 @@
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | string | 字符串类型,值内容 |
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | ------------------ |
|
||||
| `section` | string | 字符串类型,节名 |
|
||||
| `ident` | string | 字符串类型,键值名 |
|
||||
| `value` | string | 字符串类型,值内容 |
|
||||
|
||||
返回:any
|
||||
|
||||
Reference in New Issue
Block a user