@maiyunnet/kebab 7.6.0 → 7.6.1

package/doc/sc/api/lib/text/functions/parseJson.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / parseJson
+
+# Function: parseJson()
+
+> **parseJson**(`str`): `any`
+
+Defined in: [lib/text.ts:529](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L529)
+
+将字符串解析为对象，返回 false 代表解析失败，支持 BigInt
+
+## Parameters
+
+### str
+
+`string`
+
+要解析的 json 字符串
+
+## Returns
+
+`any`

package/doc/sc/api/lib/text/functions/parseUrl.md

@@ -0,0 +1,23 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / parseUrl
+
+# Function: parseUrl()
+
+> **parseUrl**(`url`): [`IUrlParse`](../../../index/interfaces/IUrlParse.md)
+
+Defined in: [lib/text.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L28)
+
+格式化一段 URL
+
+## Parameters
+
+### url
+
+`string`
+
+## Returns
+
+[`IUrlParse`](../../../index/interfaces/IUrlParse.md)

package/doc/sc/api/lib/text/functions/queryParse.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / queryParse
+
+# Function: queryParse()
+
+> **queryParse**(`query`): `Record`\<`string`, `string` \| `string`[]\>
+
+Defined in: [lib/text.ts:415](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L415)
+
+将 query string 转换为对象
+
+## Parameters
+
+### query
+
+`string`
+
+要转换的字符串
+
+## Returns
+
+`Record`\<`string`, `string` \| `string`[]\>

package/doc/sc/api/lib/text/functions/queryStringify.md

@@ -0,0 +1,69 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / queryStringify
+
+# Function: queryStringify()
+
+## Call Signature
+
+> **queryStringify**(`query`, `encode?`): `string`
+
+Defined in: [lib/text.ts:374](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L374)
+
+将对象转换为 query string
+
+### Parameters
+
+#### query
+
+`Record`\<`string`, `any`\>
+
+要转换的对象
+
+#### encode?
+
+`boolean`
+
+是否转义，默认为 true
+
+### Returns
+
+`string`
+
+## Call Signature
+
+> **queryStringify**(`query`, `options`): `string`
+
+Defined in: [lib/text.ts:380](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L380)
+
+将对象转换为 query string
+
+### Parameters
+
+#### query
+
+`Record`\<`string`, `any`\>
+
+要转换的对象
+
+#### options
+
+选项
+
+##### equal?
+
+`string`
+
+等号分隔符，默认 =
+
+##### hyphen?
+
+`string`
+
+连字符分隔符，默认 &
+
+### Returns
+
+`string`

package/doc/sc/api/lib/text/functions/sizeFormat.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / sizeFormat
+
+# Function: sizeFormat()
+
+> **sizeFormat**(`size`, `spliter`): `string`
+
+Defined in: [lib/text.ts:15](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L15)
+
+将文件大小格式化为带单位的字符串
+
+## Parameters
+
+### size
+
+`number`
+
+文件大小
+
+### spliter
+
+`string` = `' '`
+
+分隔符
+
+## Returns
+
+`string`

package/doc/sc/api/lib/text/functions/str2int.md

@@ -0,0 +1,36 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / str2int
+
+# Function: str2int()
+
+> **str2int**(`str`, `digits`): `number`
+
+Defined in: [lib/text.ts:649](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L649)
+
+为解决精度问题，将字符串数字转换为整数显示
+以下几个示例都是当 digits 为 2 时
+str 传入 '1.234'，返回 123
+str 传入 '1.235'，返回 124
+str 传入 '1.1'，返回 110
+str 传入 '6'，返回 600
+
+## Parameters
+
+### str
+
+`string`
+
+要转换的数字字符串
+
+### digits
+
+`number` = `3`
+
+小数点右移位数
+
+## Returns
+
+`number`

package/doc/sc/api/lib/text/functions/stringifyBuffer.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / stringifyBuffer
+
+# Function: stringifyBuffer()
+
+> **stringifyBuffer**(`buf`): `string`
+
+Defined in: [lib/text.ts:572](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L572)
+
+输出文本格式的 buffer
+
+## Parameters
+
+### buf
+
+`Buffer`
+
+原始 buffer
+
+## Returns
+
+`string`

package/doc/sc/api/lib/text/functions/stringifyJson.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / stringifyJson
+
+# Function: stringifyJson()
+
+> **stringifyJson**(`obj`, `space?`): `string`
+
+Defined in: [lib/text.ts:559](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L559)
+
+将对象转换为 json 字符串，返回 false 代表解析失败，支持 BigInt
+
+## Parameters
+
+### obj
+
+`any`
+
+要转换的 json 对象
+
+### space?
+
+美化方式
+
+`string` | `number`
+
+## Returns
+
+`string`

package/doc/sc/api/lib/text/functions/stringifyResult.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / stringifyResult
+
+# Function: stringifyResult()
+
+> **stringifyResult**(`rtn`): `string`
+
+Defined in: [lib/text.ts:489](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L489)
+
+将普通的返回 JSON 对象序列化为字符串
+
+## Parameters
+
+### rtn
+
+`any`
+
+返回 JSON 对象
+
+## Returns
+
+`string`

package/doc/sc/api/lib/text/functions/trimJson.md

@@ -0,0 +1,23 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / trimJson
+
+# Function: trimJson()
+
+> **trimJson**(`json`): `any`
+
+Defined in: [lib/text.ts:580](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L580)
+
+递归删除 json 中的字符串首尾空格，会返回一个新的对象
+
+## Parameters
+
+### json
+
+`any`
+
+## Returns
+
+`any`

package/doc/sc/api/lib/text/functions/urlAtom.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / urlAtom
+
+# Function: urlAtom()
+
+> **urlAtom**(`url`): `string`
+
+Defined in: [lib/text.ts:173](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L173)
+
+将路径中的 ../ ./ 都按规范妥善处理
+
+## Parameters
+
+### url
+
+`string`
+
+要处理的地址
+
+## Returns
+
+`string`

package/doc/sc/api/lib/text/functions/urlResolve.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / urlResolve
+
+# Function: urlResolve()
+
+> **urlResolve**(`from`, `to`): `string`
+
+Defined in: [lib/text.ts:111](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L111)
+
+将相对路径根据基准路径进行转换
+
+## Parameters
+
+### from
+
+`string`
+
+基准路径
+
+### to
+
+`string`
+
+相对路径
+
+## Returns
+
+`string`

package/doc/sc/api/lib/text/index.md

@@ -0,0 +1,55 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/text
+
+# lib/text
+
+## Interfaces
+
+- [IDomain](interfaces/IDomain.md)
+
+## Type Aliases
+
+- [TFalsy](type-aliases/TFalsy.md)
+
+## Variables
+
+- [REGEXP\_ASCII](variables/REGEXP_ASCII.md)
+- [REGEXP\_DOMAIN](variables/REGEXP_DOMAIN.md)
+- [REGEXP\_EMAIL](variables/REGEXP_EMAIL.md)
+- [REGEXP\_IPV4](variables/REGEXP_IPV4.md)
+- [REGEXP\_IPV6](variables/REGEXP_IPV6.md)
+
+## Functions
+
+- [getFilename](functions/getFilename.md)
+- [htmlescape](functions/htmlescape.md)
+- [int2str](functions/int2str.md)
+- [isAscii](functions/isAscii.md)
+- [isDomain](functions/isDomain.md)
+- [isEMail](functions/isEMail.md)
+- [isFalsy](functions/isFalsy.md)
+- [isIdCardCN](functions/isIdCardCN.md)
+- [isIPv4](functions/isIPv4.md)
+- [isIPv6](functions/isIPv6.md)
+- [isPhoneCN](functions/isPhoneCN.md)
+- [isRealPath](functions/isRealPath.md)
+- [isTruthy](functions/isTruthy.md)
+- [logicalOr](functions/logicalOr.md)
+- [match](functions/match.md)
+- [nlReplace](functions/nlReplace.md)
+- [parseDomain](functions/parseDomain.md)
+- [parseJson](functions/parseJson.md)
+- [parseUrl](functions/parseUrl.md)
+- [queryParse](functions/queryParse.md)
+- [queryStringify](functions/queryStringify.md)
+- [sizeFormat](functions/sizeFormat.md)
+- [str2int](functions/str2int.md)
+- [stringifyBuffer](functions/stringifyBuffer.md)
+- [stringifyJson](functions/stringifyJson.md)
+- [stringifyResult](functions/stringifyResult.md)
+- [trimJson](functions/trimJson.md)
+- [urlAtom](functions/urlAtom.md)
+- [urlResolve](functions/urlResolve.md)

package/doc/sc/api/lib/text/interfaces/IDomain.md

@@ -0,0 +1,43 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / IDomain
+
+# Interface: IDomain
+
+Defined in: [lib/text.ts:255](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L255)
+
+解析后的 domain
+
+## Properties
+
+### domain
+
+> **domain**: `string` \| `null`
+
+Defined in: [lib/text.ts:258](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L258)
+
+***
+
+### sld
+
+> **sld**: `string` \| `null`
+
+Defined in: [lib/text.ts:257](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L257)
+
+***
+
+### sub
+
+> **sub**: `string` \| `null`
+
+Defined in: [lib/text.ts:259](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L259)
+
+***
+
+### tld
+
+> **tld**: `string` \| `null`
+
+Defined in: [lib/text.ts:256](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L256)

package/doc/sc/api/lib/text/type-aliases/TFalsy.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / TFalsy
+
+# Type Alias: TFalsy
+
+> **TFalsy** = `false` \| `""` \| `0` \| `null` \| `undefined` \| *typeof* `NaN`
+
+Defined in: [lib/text.ts:612](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L612)
+
+虚假值类型

package/doc/sc/api/lib/text/variables/REGEXP_ASCII.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / REGEXP\_ASCII
+
+# Variable: REGEXP\_ASCII
+
+> `const` **REGEXP\_ASCII**: `RegExp`
+
+Defined in: [lib/text.ts:228](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L228)
+
+可打印的 ascii 字符集

package/doc/sc/api/lib/text/variables/REGEXP_DOMAIN.md

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / REGEXP\_DOMAIN
+
+# Variable: REGEXP\_DOMAIN
+
+> `const` **REGEXP\_DOMAIN**: `RegExp`
+
+Defined in: [lib/text.ts:216](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L216)

package/doc/sc/api/lib/text/variables/REGEXP_EMAIL.md

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / REGEXP\_EMAIL
+
+# Variable: REGEXP\_EMAIL
+
+> `const` **REGEXP\_EMAIL**: `RegExp`
+
+Defined in: [lib/text.ts:186](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L186)

package/doc/sc/api/lib/text/variables/REGEXP_IPV4.md

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / REGEXP\_IPV4
+
+# Variable: REGEXP\_IPV4
+
+> `const` **REGEXP\_IPV4**: `RegExp`
+
+Defined in: [lib/text.ts:196](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L196)

package/doc/sc/api/lib/text/variables/REGEXP_IPV6.md

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / REGEXP\_IPV6
+
+# Variable: REGEXP\_IPV6
+
+> `const` **REGEXP\_IPV6**: `RegExp`
+
+Defined in: [lib/text.ts:206](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L206)

package/doc/sc/api/lib/time/classes/Time.md

@@ -0,0 +1,125 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/time](../index.md) / Time
+
+# Class: Time
+
+Defined in: [lib/time.ts:33](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L33)
+
+## Constructors
+
+### Constructor
+
+> **new Time**(`ctr`, `opt`): `Time`
+
+Defined in: [lib/time.ts:45](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L45)
+
+构造函数
+
+#### Parameters
+
+##### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+##### opt
+
+[`IOptions`](../interfaces/IOptions.md)
+
+#### Returns
+
+`Time`
+
+## Methods
+
+### format()
+
+> **format**(`f`, `zone?`): `string`
+
+Defined in: [lib/time.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L97)
+
+获取格式化的字符串
+
+#### Parameters
+
+##### f
+
+`string`
+
+格式化字符串
+
+##### zone?
+
+`number`
+
+时区小时，如 8
+
+#### Returns
+
+`string`
+
+***
+
+### getZone()
+
+> **getZone**(): `number`
+
+Defined in: [lib/time.ts:81](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L81)
+
+获取时区
+
+#### Returns
+
+`number`
+
+***
+
+### setZone()
+
+> **setZone**(`zone`): `void`
+
+Defined in: [lib/time.ts:74](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L74)
+
+设置时区
+
+#### Parameters
+
+##### zone
+
+`number`
+
+北京时间如 8
+
+#### Returns
+
+`void`
+
+***
+
+### stamp()
+
+> **stamp**(): `number`
+
+Defined in: [lib/time.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L104)
+
+获取秒级时间戳
+
+#### Returns
+
+`number`
+
+***
+
+### toUTCString()
+
+> **toUTCString**(): `string`
+
+Defined in: [lib/time.ts:88](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L88)
+
+获取 UTC 字符串
+
+#### Returns
+
+`string`