Skip to content

Commit 7f5a006

Browse files
update doc
1 parent ade268f commit 7f5a006

File tree

83 files changed

+1458
-615
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+1458
-615
lines changed

docs/classes/BlobReader.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: BlobReader
88

9-
Defined in: [index.d.ts:393](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L393)
9+
Defined in: [index.d.ts:393](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L393)
1010

1111
Represents a [Reader](Reader.md) instance used to read data provided as a `Blob` instance.
1212

@@ -20,7 +20,7 @@ Represents a [Reader](Reader.md) instance used to read data provided as a `Blob`
2020

2121
> **new BlobReader**(`value`): `BlobReader`
2222
23-
Defined in: [index.d.ts:362](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L362)
23+
Defined in: [index.d.ts:362](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L362)
2424

2525
Creates the [Reader](Reader.md) instance
2626

@@ -46,7 +46,7 @@ The data to read.
4646

4747
> **readable**: `ReadableStream`
4848
49-
Defined in: [index.d.ts:366](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L366)
49+
Defined in: [index.d.ts:366](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L366)
5050

5151
The `ReadableStream` instance.
5252

@@ -60,7 +60,7 @@ The `ReadableStream` instance.
6060

6161
> **size**: `number`
6262
63-
Defined in: [index.d.ts:370](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L370)
63+
Defined in: [index.d.ts:370](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L370)
6464

6565
The total size of the data in bytes.
6666

@@ -74,7 +74,7 @@ The total size of the data in bytes.
7474

7575
> `optional` **init**(): `Promise`\<`void`\>
7676
77-
Defined in: [index.d.ts:374](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L374)
77+
Defined in: [index.d.ts:374](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L374)
7878

7979
Initializes the instance asynchronously
8080

@@ -92,7 +92,7 @@ Initializes the instance asynchronously
9292

9393
> **readUint8Array**(`index`, `length`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
9494
95-
Defined in: [index.d.ts:382](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L382)
95+
Defined in: [index.d.ts:382](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L382)
9696

9797
Reads a chunk of data
9898

docs/classes/BlobWriter.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: BlobWriter
88

9-
Defined in: [index.d.ts:573](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L573)
9+
Defined in: [index.d.ts:573](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L573)
1010

1111
Represents a [WritableWriter](../interfaces/WritableWriter.md) instance used to retrieve the written data as a `Blob` instance.
1212

@@ -21,7 +21,7 @@ Represents a [WritableWriter](../interfaces/WritableWriter.md) instance used to
2121

2222
> **new BlobWriter**(`mimeString?`): `BlobWriter`
2323
24-
Defined in: [index.d.ts:587](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L587)
24+
Defined in: [index.d.ts:587](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L587)
2525

2626
Creates the BlobWriter instance
2727

@@ -43,7 +43,7 @@ The MIME type of the content.
4343

4444
> **writable**: `WritableStream`
4545
46-
Defined in: [index.d.ts:577](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L577)
46+
Defined in: [index.d.ts:577](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L577)
4747

4848
The `WritableStream` instance.
4949

@@ -57,7 +57,7 @@ The `WritableStream` instance.
5757

5858
> **getData**(): `Promise`\<`Blob`\>
5959
60-
Defined in: [index.d.ts:593](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L593)
60+
Defined in: [index.d.ts:593](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L593)
6161

6262
Retrieves all the written data
6363

@@ -73,7 +73,7 @@ A promise resolving to the written data.
7373

7474
> **init**(): `Promise`\<`void`\>
7575
76-
Defined in: [index.d.ts:581](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L581)
76+
Defined in: [index.d.ts:581](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L581)
7777

7878
Initializes the instance asynchronously
7979

docs/classes/CodecStream.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: CodecStream
88

9-
Defined in: [index.d.ts:295](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L295)
9+
Defined in: [index.d.ts:295](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L295)
1010

1111
Represents a class implementing `CompressionStream` or `DecompressionStream` interfaces.
1212

docs/classes/Data64URIReader.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: Data64URIReader
88

9-
Defined in: [index.d.ts:398](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L398)
9+
Defined in: [index.d.ts:398](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L398)
1010

1111
Represents a [Reader](Reader.md) instance used to read data provided as a Data URI `string` encoded in Base64.
1212

@@ -20,7 +20,7 @@ Represents a [Reader](Reader.md) instance used to read data provided as a Data U
2020

2121
> **new Data64URIReader**(`value`): `Data64URIReader`
2222
23-
Defined in: [index.d.ts:362](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L362)
23+
Defined in: [index.d.ts:362](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L362)
2424

2525
Creates the [Reader](Reader.md) instance
2626

@@ -46,7 +46,7 @@ The data to read.
4646

4747
> **readable**: `ReadableStream`
4848
49-
Defined in: [index.d.ts:366](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L366)
49+
Defined in: [index.d.ts:366](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L366)
5050

5151
The `ReadableStream` instance.
5252

@@ -60,7 +60,7 @@ The `ReadableStream` instance.
6060

6161
> **size**: `number`
6262
63-
Defined in: [index.d.ts:370](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L370)
63+
Defined in: [index.d.ts:370](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L370)
6464

6565
The total size of the data in bytes.
6666

@@ -74,7 +74,7 @@ The total size of the data in bytes.
7474

7575
> `optional` **init**(): `Promise`\<`void`\>
7676
77-
Defined in: [index.d.ts:374](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L374)
77+
Defined in: [index.d.ts:374](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L374)
7878

7979
Initializes the instance asynchronously
8080

@@ -92,7 +92,7 @@ Initializes the instance asynchronously
9292

9393
> **readUint8Array**(`index`, `length`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
9494
95-
Defined in: [index.d.ts:382](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L382)
95+
Defined in: [index.d.ts:382](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L382)
9696

9797
Reads a chunk of data
9898

docs/classes/Data64URIWriter.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: Data64URIWriter
88

9-
Defined in: [index.d.ts:599](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L599)
9+
Defined in: [index.d.ts:599](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L599)
1010

1111
Represents a [Writer](Writer.md) instance used to retrieve the written data as a Data URI `string` encoded in Base64.
1212

@@ -20,7 +20,7 @@ Represents a [Writer](Writer.md) instance used to retrieve the written data as a
2020

2121
> **new Data64URIWriter**(`mimeString?`): `Data64URIWriter`
2222
23-
Defined in: [index.d.ts:605](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L605)
23+
Defined in: [index.d.ts:605](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L605)
2424

2525
Creates the Data64URIWriter instance
2626

@@ -46,7 +46,7 @@ The MIME type of the content.
4646

4747
> **writable**: `WritableStream`
4848
49-
Defined in: [index.d.ts:535](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L535)
49+
Defined in: [index.d.ts:535](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L535)
5050

5151
The `WritableStream` instance.
5252

@@ -60,7 +60,7 @@ The `WritableStream` instance.
6060

6161
> **getData**(): `Promise`\<`string`\>
6262
63-
Defined in: [index.d.ts:555](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L555)
63+
Defined in: [index.d.ts:555](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L555)
6464

6565
Retrieves all the written data
6666

@@ -80,7 +80,7 @@ A promise resolving to the written data.
8080

8181
> `optional` **init**(`size?`): `Promise`\<`void`\>
8282
83-
Defined in: [index.d.ts:541](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L541)
83+
Defined in: [index.d.ts:541](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L541)
8484

8585
Initializes the instance asynchronously
8686

@@ -106,7 +106,7 @@ the total size of the written data in bytes.
106106

107107
> **writeUint8Array**(`array`): `Promise`\<`void`\>
108108
109-
Defined in: [index.d.ts:549](https://github.com/gildas-lormeau/zip.js/blob/048592eb3ecd62abf9aa99b38374e6c15b43dfe8/index.d.ts#L549)
109+
Defined in: [index.d.ts:549](https://github.com/gildas-lormeau/zip.js/blob/ade268faf16563c7a33ab45fce2e8761620ea353/index.d.ts#L549)
110110

111111
Appends a chunk of data
112112

0 commit comments

Comments
 (0)