@maiyunnet/kebab 7.6.0 → 7.6.1

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

@@ -0,0 +1,29 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/zip
+
+# lib/zip
+
+## Classes
+
+- [Zip](classes/Zip.md)
+
+## Interfaces
+
+- [IZipInputByType](interfaces/IZipInputByType.md)
+- [IZipItem](interfaces/IZipItem.md)
+- [IZipMetadata](interfaces/IZipMetadata.md)
+- [IZipOutputByType](interfaces/IZipOutputByType.md)
+- [IZipStats](interfaces/IZipStats.md)
+
+## Type Aliases
+
+- [TZipInputFileFormat](type-aliases/TZipInputFileFormat.md)
+- [TZipInputType](type-aliases/TZipInputType.md)
+- [TZipOutputType](type-aliases/TZipOutputType.md)
+
+## Functions
+
+- [get](functions/get.md)

package/doc/sc/api/lib/zip/interfaces/IZipInputByType.md

@@ -0,0 +1,81 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / IZipInputByType
+
+# Interface: IZipInputByType
+
+Defined in: [lib/zip.ts:475](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L475)
+
+## Properties
+
+### array
+
+> **array**: `number`[]
+
+Defined in: [lib/zip.ts:480](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L480)
+
+***
+
+### arraybuffer
+
+> **arraybuffer**: `ArrayBuffer`
+
+Defined in: [lib/zip.ts:482](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L482)
+
+***
+
+### base64
+
+> **base64**: `string`
+
+Defined in: [lib/zip.ts:476](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L476)
+
+***
+
+### binarystring
+
+> **binarystring**: `string`
+
+Defined in: [lib/zip.ts:479](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L479)
+
+***
+
+### blob
+
+> **blob**: `Blob`
+
+Defined in: [lib/zip.ts:483](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L483)
+
+***
+
+### nodebuffer
+
+> **nodebuffer**: `Buffer`
+
+Defined in: [lib/zip.ts:484](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L484)
+
+***
+
+### string
+
+> **string**: `string`
+
+Defined in: [lib/zip.ts:477](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L477)
+
+***
+
+### text
+
+> **text**: `string`
+
+Defined in: [lib/zip.ts:478](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L478)
+
+***
+
+### uint8array
+
+> **uint8array**: `Uint8Array`
+
+Defined in: [lib/zip.ts:481](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L481)

package/doc/sc/api/lib/zip/interfaces/IZipItem.md

@@ -0,0 +1,65 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / IZipItem
+
+# Interface: IZipItem
+
+Defined in: [lib/zip.ts:443](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L443)
+
+## Properties
+
+### compressedSize
+
+> **compressedSize**: `number`
+
+Defined in: [lib/zip.ts:445](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L445)
+
+***
+
+### date
+
+> **date**: `Date`
+
+Defined in: [lib/zip.ts:447](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L447)
+
+***
+
+### isDirectory
+
+> **isDirectory**: `boolean`
+
+Defined in: [lib/zip.ts:449](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L449)
+
+***
+
+### isFile
+
+> **isFile**: `boolean`
+
+Defined in: [lib/zip.ts:448](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L448)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [lib/zip.ts:444](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L444)
+
+***
+
+### path
+
+> **path**: `string`
+
+Defined in: [lib/zip.ts:450](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L450)
+
+***
+
+### uncompressedSize
+
+> **uncompressedSize**: `number`
+
+Defined in: [lib/zip.ts:446](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L446)

package/doc/sc/api/lib/zip/interfaces/IZipMetadata.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / IZipMetadata
+
+# Interface: IZipMetadata
+
+Defined in: [lib/zip.ts:491](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L491)
+
+## Properties
+
+### currentFile
+
+> **currentFile**: `string` \| `null`
+
+Defined in: [lib/zip.ts:493](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L493)
+
+***
+
+### percent
+
+> **percent**: `number`
+
+Defined in: [lib/zip.ts:492](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L492)

package/doc/sc/api/lib/zip/interfaces/IZipOutputByType.md

@@ -0,0 +1,81 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / IZipOutputByType
+
+# Interface: IZipOutputByType
+
+Defined in: [lib/zip.ts:461](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L461)
+
+## Properties
+
+### array
+
+> **array**: `number`[]
+
+Defined in: [lib/zip.ts:466](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L466)
+
+***
+
+### arraybuffer
+
+> **arraybuffer**: `ArrayBuffer`
+
+Defined in: [lib/zip.ts:468](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L468)
+
+***
+
+### base64
+
+> **base64**: `string`
+
+Defined in: [lib/zip.ts:462](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L462)
+
+***
+
+### binarystring
+
+> **binarystring**: `string`
+
+Defined in: [lib/zip.ts:465](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L465)
+
+***
+
+### blob
+
+> **blob**: `Blob`
+
+Defined in: [lib/zip.ts:469](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L469)
+
+***
+
+### nodebuffer
+
+> **nodebuffer**: `Buffer`
+
+Defined in: [lib/zip.ts:470](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L470)
+
+***
+
+### string
+
+> **string**: `string`
+
+Defined in: [lib/zip.ts:463](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L463)
+
+***
+
+### text
+
+> **text**: `string`
+
+Defined in: [lib/zip.ts:464](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L464)
+
+***
+
+### uint8array
+
+> **uint8array**: `Uint8Array`
+
+Defined in: [lib/zip.ts:467](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L467)

package/doc/sc/api/lib/zip/interfaces/IZipStats.md

@@ -0,0 +1,49 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / IZipStats
+
+# Interface: IZipStats
+
+Defined in: [lib/zip.ts:453](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L453)
+
+## Properties
+
+### compressedSize
+
+> **compressedSize**: `number`
+
+Defined in: [lib/zip.ts:454](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L454)
+
+***
+
+### date
+
+> **date**: `Date`
+
+Defined in: [lib/zip.ts:456](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L456)
+
+***
+
+### isDirectory
+
+> **isDirectory**: `boolean`
+
+Defined in: [lib/zip.ts:458](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L458)
+
+***
+
+### isFile
+
+> **isFile**: `boolean`
+
+Defined in: [lib/zip.ts:457](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L457)
+
+***
+
+### uncompressedSize
+
+> **uncompressedSize**: `number`
+
+Defined in: [lib/zip.ts:455](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L455)

package/doc/sc/api/lib/zip/type-aliases/TZipInputFileFormat.md

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / TZipInputFileFormat
+
+# Type Alias: TZipInputFileFormat
+
+> **TZipInputFileFormat** = [`IZipInputByType`](../interfaces/IZipInputByType.md)\[keyof [`IZipInputByType`](../interfaces/IZipInputByType.md)\]
+
+Defined in: [lib/zip.ts:489](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L489)

package/doc/sc/api/lib/zip/type-aliases/TZipInputType.md

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / TZipInputType
+
+# Type Alias: TZipInputType
+
+> **TZipInputType** = keyof [`IZipInputByType`](../interfaces/IZipInputByType.md)
+
+Defined in: [lib/zip.ts:487](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L487)

package/doc/sc/api/lib/zip/type-aliases/TZipOutputType.md

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / TZipOutputType
+
+# Type Alias: TZipOutputType
+
+> **TZipOutputType** = keyof [`IZipOutputByType`](../interfaces/IZipOutputByType.md)
+
+Defined in: [lib/zip.ts:473](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L473)

package/doc/sc/api/lib/zlib/functions/brotliCompress.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / brotliCompress
+
+# Function: brotliCompress()
+
+> **brotliCompress**(`buffer`, `options`): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
+
+Defined in: [lib/zlib.ts:212](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L212)
+
+Brotli 压缩一段
+
+## Parameters
+
+### buffer
+
+`InputType`
+
+段
+
+### options
+
+`ZlibOptions` = `{}`
+
+选项
+
+## Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>

package/doc/sc/api/lib/zlib/functions/brotliDecompress.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / brotliDecompress
+
+# Function: brotliDecompress()
+
+> **brotliDecompress**(`buffer`): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
+
+Defined in: [lib/zlib.ts:230](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L230)
+
+Brotli 解压一段
+
+## Parameters
+
+### buffer
+
+`InputType`
+
+段
+
+## Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>

package/doc/sc/api/lib/zlib/functions/compress.md

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / compress
+
+# Function: compress()
+
+> **compress**(`types`, `buffer`, `options?`): `Promise`\<[`ICompressBuffer`](../interfaces/ICompressBuffer.md) \| `null`\>
+
+Defined in: [lib/zlib.ts:249](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L249)
+
+根据 types 判断用什么加密的段
+
+## Parameters
+
+### types
+
+`string`
+
+用,间隔的字符串，如 gzip,deflate
+
+### buffer
+
+段
+
+`InputType` | `null`
+
+### options?
+
+`ZlibOptions`
+
+选项
+
+## Returns
+
+`Promise`\<[`ICompressBuffer`](../interfaces/ICompressBuffer.md) \| `null`\>

package/doc/sc/api/lib/zlib/functions/createBrotliCompress.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / createBrotliCompress
+
+# Function: createBrotliCompress()
+
+> **createBrotliCompress**(`options`): `BrotliCompress`
+
+Defined in: [lib/zlib.ts:57](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L57)
+
+创建 Brotli 压缩对象
+
+## Parameters
+
+### options
+
+`ZlibOptions` = `{}`
+
+选项
+
+## Returns
+
+`BrotliCompress`

package/doc/sc/api/lib/zlib/functions/createBrotliDecompress.md

@@ -0,0 +1,17 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / createBrotliDecompress
+
+# Function: createBrotliDecompress()
+
+> **createBrotliDecompress**(): `BrotliDecompress`
+
+Defined in: [lib/zlib.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L65)
+
+创建 Brotli 解压对象
+
+## Returns
+
+`BrotliDecompress`

package/doc/sc/api/lib/zlib/functions/createCompress.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / createCompress
+
+# Function: createCompress()
+
+> **createCompress**(`types`, `options`): [`ICompress`](../interfaces/ICompress.md) \| `null`
+
+Defined in: [lib/zlib.ts:74](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L74)
+
+根据字符串创建压缩类型
+
+## Parameters
+
+### types
+
+`string`
+
+用 , 间隔的字符串，如 gzip,deflate
+
+### options
+
+`ZlibOptions` = `{}`
+
+选项
+
+## Returns
+
+[`ICompress`](../interfaces/ICompress.md) \| `null`

package/doc/sc/api/lib/zlib/functions/createDecompress.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / createDecompress
+
+# Function: createDecompress()
+
+> **createDecompress**(`types`): [`ICompress`](../interfaces/ICompress.md) \| `null`
+
+Defined in: [lib/zlib.ts:107](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L107)
+
+根据字符串创建解压类型
+
+## Parameters
+
+### types
+
+`string`
+
+用 , 间隔的字符串，如 gzip, deflate
+
+## Returns
+
+[`ICompress`](../interfaces/ICompress.md) \| `null`

package/doc/sc/api/lib/zlib/functions/createDeflate.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / createDeflate
+
+# Function: createDeflate()
+
+> **createDeflate**(`options`): `Deflate`
+
+Defined in: [lib/zlib.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L41)
+
+创建 Deflate 对象
+
+## Parameters
+
+### options
+
+`ZlibOptions` = `{}`
+
+选项
+
+## Returns
+
+`Deflate`

package/doc/sc/api/lib/zlib/functions/createGunzip.md

@@ -0,0 +1,17 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / createGunzip
+
+# Function: createGunzip()
+
+> **createGunzip**(): `Gunzip`
+
+Defined in: [lib/zlib.ts:33](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L33)
+
+创建 Gzip 解压对象
+
+## Returns
+
+`Gunzip`

package/doc/sc/api/lib/zlib/functions/createGzip.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / createGzip
+
+# Function: createGzip()
+
+> **createGzip**(`options`): `Gzip`
+
+Defined in: [lib/zlib.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L25)
+
+创建 Gzip 对象
+
+## Parameters
+
+### options
+
+`ZlibOptions` = `{}`
+
+选项
+
+## Returns
+
+`Gzip`

package/doc/sc/api/lib/zlib/functions/createInflate.md

@@ -0,0 +1,17 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / createInflate
+
+# Function: createInflate()
+
+> **createInflate**(): `Inflate`
+
+Defined in: [lib/zlib.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L49)
+
+创建 Deflate 解压对象
+
+## Returns
+
+`Inflate`

package/doc/sc/api/lib/zlib/functions/decompress.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zlib](../index.md) / decompress
+
+# Function: decompress()
+
+> **decompress**(`types`, `buffer`): `Promise`\<[`ICompressBuffer`](../interfaces/ICompressBuffer.md) \| `null`\>
+
+Defined in: [lib/zlib.ts:290](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L290)
+
+根据 types 判断用什么解密的段
+
+## Parameters
+
+### types
+
+`string`
+
+用,间隔的字符串，如 gzip,deflate
+
+### buffer
+
+段
+
+`InputType` | `null`
+
+## Returns
+
+`Promise`\<[`ICompressBuffer`](../interfaces/ICompressBuffer.md) \| `null`\>