@maiyunnet/kebab 7.6.0 → 7.6.1

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

@@ -0,0 +1,17 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/cron
+
+# lib/cron
+
+## Interfaces
+
+- [IRegular](interfaces/IRegular.md)
+- [IRegularData](interfaces/IRegularData.md)
+
+## Functions
+
+- [getRegulars](functions/getRegulars.md)
+- [regular](functions/regular.md)

package/doc/sc/api/lib/cron/interfaces/IRegular.md

@@ -0,0 +1,59 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cron](../index.md) / IRegular
+
+# Interface: IRegular
+
+Defined in: [lib/cron.ts:93](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L93)
+
+定时任务
+
+## Extended by
+
+- [`IRegularData`](IRegularData.md)
+
+## Properties
+
+### callback()
+
+> **callback**: (`date`, `immediate`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [lib/cron.ts:99](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L99)
+
+任务函数
+
+#### Parameters
+
+##### date
+
+`string`
+
+##### immediate
+
+`boolean`
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [lib/cron.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L95)
+
+任务名称，只能小写字母、数字、短横线、下划线，长度 1-32
+
+***
+
+### rule
+
+> **rule**: `string`
+
+Defined in: [lib/cron.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L97)
+
+规则，分、时、日、月、星期，与 linux 的 cron 相同（不支持秒）

package/doc/sc/api/lib/cron/interfaces/IRegularData.md

@@ -0,0 +1,101 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cron](../index.md) / IRegularData
+
+# Interface: IRegularData
+
+Defined in: [lib/cron.ts:102](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L102)
+
+定时任务
+
+## Extends
+
+- [`IRegular`](IRegular.md)
+
+## Properties
+
+### callback()
+
+> **callback**: (`date`, `immediate`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [lib/cron.ts:99](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L99)
+
+任务函数
+
+#### Parameters
+
+##### date
+
+`string`
+
+##### immediate
+
+`boolean`
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+#### Inherited from
+
+[`IRegular`](IRegular.md).[`callback`](IRegular.md#callback)
+
+***
+
+### count
+
+> **count**: `number`
+
+Defined in: [lib/cron.ts:106](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L106)
+
+总执行次数
+
+***
+
+### last
+
+> **last**: `string`
+
+Defined in: [lib/cron.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L104)
+
+上次执行时间字符串，格式：YmdHi（系统时区）
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [lib/cron.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L95)
+
+任务名称，只能小写字母、数字、短横线、下划线，长度 1-32
+
+#### Inherited from
+
+[`IRegular`](IRegular.md).[`name`](IRegular.md#name)
+
+***
+
+### rcount
+
+> **rcount**: `number`
+
+Defined in: [lib/cron.ts:108](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L108)
+
+定时任务重启后的执行次数
+
+***
+
+### rule
+
+> **rule**: `string`
+
+Defined in: [lib/cron.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L97)
+
+规则，分、时、日、月、星期，与 linux 的 cron 相同（不支持秒）
+
+#### Inherited from
+
+[`IRegular`](IRegular.md).[`rule`](IRegular.md#rule)

package/doc/sc/api/lib/crypto/functions/aesDecrypt.md

@@ -0,0 +1,91 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / aesDecrypt
+
+# Function: aesDecrypt()
+
+## Call Signature
+
+> **aesDecrypt**(`encrypt`, `key`, `iv`, `method`, `output`): `false` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [lib/crypto.ts:339](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L339)
+
+AES 解密
+
+### Parameters
+
+#### encrypt
+
+需解密的字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+#### iv
+
+`string`
+
+向量 16(CTR) 或 12(GCM) 个英文字母和数字
+
+#### method
+
+`string`
+
+加密方法
+
+#### output
+
+`"buffer"`
+
+### Returns
+
+`false` \| `Buffer`\<`ArrayBufferLike`\>
+
+## Call Signature
+
+> **aesDecrypt**(`encrypt`, `key`, `iv?`, `method?`, `output?`): `string` \| `false`
+
+Defined in: [lib/crypto.ts:340](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L340)
+
+AES 解密
+
+### Parameters
+
+#### encrypt
+
+需解密的字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+#### iv?
+
+`string`
+
+向量 16(CTR) 或 12(GCM) 个英文字母和数字
+
+#### method?
+
+`string`
+
+加密方法
+
+#### output?
+
+`"binary"`
+
+### Returns
+
+`string` \| `false`

package/doc/sc/api/lib/crypto/functions/aesEncrypt.md

@@ -0,0 +1,95 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / aesEncrypt
+
+# Function: aesEncrypt()
+
+## Call Signature
+
+> **aesEncrypt**(`original`, `key`, `iv`, `method`, `output`): `false` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [lib/crypto.ts:226](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L226)
+
+AES 加密
+
+### Parameters
+
+#### original
+
+原始字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥尽量 32 个英文字母和数字，不是 32 个系统会自动处理
+
+#### iv
+
+`string`
+
+向量 16(CTR) 或 12(GCM) 个英文字母和数字
+
+#### method
+
+`string`
+
+加密方法
+
+#### output
+
+`"buffer"`
+
+输出类型
+
+### Returns
+
+`false` \| `Buffer`\<`ArrayBufferLike`\>
+
+## Call Signature
+
+> **aesEncrypt**(`original`, `key`, `iv?`, `method?`, `output?`): `string` \| `false`
+
+Defined in: [lib/crypto.ts:227](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L227)
+
+AES 加密
+
+### Parameters
+
+#### original
+
+原始字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥尽量 32 个英文字母和数字，不是 32 个系统会自动处理
+
+#### iv?
+
+`string`
+
+向量 16(CTR) 或 12(GCM) 个英文字母和数字
+
+#### method?
+
+`string`
+
+加密方法
+
+#### output?
+
+`"base64"`
+
+输出类型
+
+### Returns
+
+`string` \| `false`

package/doc/sc/api/lib/crypto/functions/base64Decode.md

@@ -0,0 +1,59 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / base64Decode
+
+# Function: base64Decode()
+
+## Call Signature
+
+> **base64Decode**(`data`, `encoding`): `Buffer`
+
+Defined in: [lib/crypto.ts:445](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L445)
+
+base64 解码
+
+### Parameters
+
+#### data
+
+`string`
+
+base64 编码的字符串
+
+#### encoding
+
+`"buffer"`
+
+指定解出 Buffer 还是 string
+
+### Returns
+
+`Buffer`
+
+## Call Signature
+
+> **base64Decode**(`data`, `encoding?`): `string`
+
+Defined in: [lib/crypto.ts:446](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L446)
+
+base64 解码
+
+### Parameters
+
+#### data
+
+`string`
+
+base64 编码的字符串
+
+#### encoding?
+
+`"utf8"`
+
+指定解出 Buffer 还是 string
+
+### Returns
+
+`string`

package/doc/sc/api/lib/crypto/functions/base64Encode.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / base64Encode
+
+# Function: base64Encode()
+
+> **base64Encode**(`data`): `string`
+
+Defined in: [lib/crypto.ts:431](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L431)
+
+base64 编码
+
+## Parameters
+
+### data
+
+字符串或 Buffer
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+## Returns
+
+`string`

package/doc/sc/api/lib/crypto/functions/cipherDecrypt.md

@@ -0,0 +1,49 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / cipherDecrypt
+
+# Function: cipherDecrypt()
+
+> **cipherDecrypt**(`encrypt`, `key`, `iv`, `method`, `output`): `string` \| `false` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [lib/crypto.ts:276](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L276)
+
+cipher 解密
+
+## Parameters
+
+### encrypt
+
+需解密的字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+### iv
+
+`string` = `''`
+
+向量 16(CTR) 或 12(GCM) 个英文字母和数字
+
+### method
+
+`string` = `AES_256_ECB`
+
+加密方法
+
+### output
+
+输出类型
+
+`"buffer"` | `"binary"`
+
+## Returns
+
+`string` \| `false` \| `Buffer`\<`ArrayBufferLike`\>

package/doc/sc/api/lib/crypto/functions/cipherEncrypt.md

@@ -0,0 +1,49 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / cipherEncrypt
+
+# Function: cipherEncrypt()
+
+> **cipherEncrypt**(`original`, `key`, `iv`, `method`, `output`): `string` \| `false` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [lib/crypto.ts:166](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L166)
+
+cipher 加密，强烈不建议使用 AES_256_ECB
+
+## Parameters
+
+### original
+
+原始字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+### iv
+
+`string` = `''`
+
+向量 16(CTR) 或 12(GCM) 个英文字母和数字
+
+### method
+
+`string` = `AES_256_ECB`
+
+加密方法
+
+### output
+
+输出类型
+
+`"buffer"` | `"base64"`
+
+## Returns
+
+`string` \| `false` \| `Buffer`\<`ArrayBufferLike`\>

package/doc/sc/api/lib/crypto/functions/gcmDecrypt.md

@@ -0,0 +1,71 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / gcmDecrypt
+
+# Function: gcmDecrypt()
+
+## Call Signature
+
+> **gcmDecrypt**(`encrypt`, `key`, `output`): `false` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [lib/crypto.ts:354](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L354)
+
+AES 解密
+
+### Parameters
+
+#### encrypt
+
+需解密的字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+#### output
+
+`"buffer"`
+
+输出类型
+
+### Returns
+
+`false` \| `Buffer`\<`ArrayBufferLike`\>
+
+## Call Signature
+
+> **gcmDecrypt**(`encrypt`, `key`, `output?`): `string` \| `false`
+
+Defined in: [lib/crypto.ts:355](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L355)
+
+AES 解密
+
+### Parameters
+
+#### encrypt
+
+需解密的字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+#### output?
+
+`"binary"`
+
+输出类型
+
+### Returns
+
+`string` \| `false`

package/doc/sc/api/lib/crypto/functions/gcmEncrypt.md

@@ -0,0 +1,71 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / gcmEncrypt
+
+# Function: gcmEncrypt()
+
+## Call Signature
+
+> **gcmEncrypt**(`original`, `key`, `output`): `false` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [lib/crypto.ts:241](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L241)
+
+AES GCM 托管加密
+
+### Parameters
+
+#### original
+
+原始字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥尽量 32 个英文字母和数字，不是 32 个系统会自动处理
+
+#### output
+
+`"buffer"`
+
+输出类型
+
+### Returns
+
+`false` \| `Buffer`\<`ArrayBufferLike`\>
+
+## Call Signature
+
+> **gcmEncrypt**(`original`, `key`, `output?`): `string` \| `false`
+
+Defined in: [lib/crypto.ts:242](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L242)
+
+AES GCM 托管加密
+
+### Parameters
+
+#### original
+
+原始字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥尽量 32 个英文字母和数字，不是 32 个系统会自动处理
+
+#### output?
+
+`"base64"`
+
+输出类型
+
+### Returns
+
+`string` \| `false`