@zip.js/zip.js
Advanced tools
Comparing version 2.7.35 to 2.7.36
187
index.d.ts
/** | ||
* The global object. | ||
* Represents the `FileSystemEntry` class. | ||
* | ||
* @see {@link https://wicg.github.io/entries-api/#api-entry|specification} | ||
*/ | ||
declare global { | ||
/** | ||
* Represents the `FileSystemEntry` class. | ||
* | ||
* @see {@link https://wicg.github.io/entries-api/#api-entry|specification} | ||
*/ | ||
// deno-lint-ignore no-empty-interface | ||
interface FileSystemEntry {} | ||
/** | ||
* Represents the `FileSystemHandle` class. | ||
* | ||
* @see {@link https://fs.spec.whatwg.org/#api-filesystemhandle} | ||
*/ | ||
// deno-lint-ignore no-empty-interface | ||
interface FileSystemHandle {} | ||
} | ||
// deno-lint-ignore no-empty-interface | ||
interface FileSystemEntry {} | ||
/** | ||
* Represents the `FileSystemHandle` class. | ||
* | ||
* @see {@link https://fs.spec.whatwg.org/#api-filesystemhandle} | ||
*/ | ||
// deno-lint-ignore no-empty-interface | ||
interface FileSystemHandle {} | ||
/** | ||
* Represents a generic `TransformStream` class. | ||
@@ -41,3 +37,3 @@ * | ||
*/ | ||
interface Configuration extends WorkerConfiguration { | ||
export interface Configuration extends WorkerConfiguration { | ||
/** | ||
@@ -130,3 +126,3 @@ * The maximum number of web workers used to compress/decompress data simultaneously. | ||
*/ | ||
interface WorkerConfiguration { | ||
export interface WorkerConfiguration { | ||
/** | ||
@@ -163,3 +159,3 @@ * `true` to use web workers to compress/decompress data in non-blocking background processes. | ||
*/ | ||
interface registerDataHandler { | ||
export interface registerDataHandler { | ||
/** | ||
@@ -175,3 +171,3 @@ * @param codec The third-party codec instance. | ||
*/ | ||
interface dataHandler { | ||
export interface dataHandler { | ||
/** | ||
@@ -191,3 +187,3 @@ * @param data The processed chunk of data. | ||
*/ | ||
interface EventBasedZipLibrary { | ||
export interface EventBasedZipLibrary { | ||
/** | ||
@@ -224,3 +220,3 @@ * The class used to compress data. | ||
*/ | ||
interface ZipLibrary { | ||
export interface ZipLibrary { | ||
/** | ||
@@ -291,3 +287,3 @@ * The class used to compress data. | ||
*/ | ||
interface Initializable { | ||
export interface Initializable { | ||
/** | ||
@@ -302,3 +298,3 @@ * Initializes the instance asynchronously | ||
*/ | ||
interface ReadableReader { | ||
export interface ReadableReader { | ||
/** | ||
@@ -435,3 +431,3 @@ * The `ReadableStream` instance. | ||
*/ | ||
interface HttpOptions extends HttpRangeOptions { | ||
export interface HttpOptions extends HttpRangeOptions { | ||
/** | ||
@@ -460,3 +456,3 @@ * `true` to use `Range` headers when fetching data from servers returning `Accept-Ranges` headers. | ||
*/ | ||
interface HttpRangeOptions { | ||
export interface HttpRangeOptions { | ||
/** | ||
@@ -477,3 +473,3 @@ * `true` to rely `XMLHttpRequest` instead of `fetch` to fetch data. | ||
*/ | ||
interface WritableWriter { | ||
export interface WritableWriter { | ||
/** | ||
@@ -646,18 +642,20 @@ * The `WritableStream` instance. | ||
export class ZipReaderStream<T> { | ||
/** | ||
* Creates the stream. | ||
* | ||
* @param options The options. | ||
*/ | ||
constructor (options?: ZipReaderConstructorOptions); | ||
/** | ||
* Creates the stream. | ||
* | ||
* @param options The options. | ||
*/ | ||
constructor(options?: ZipReaderConstructorOptions); | ||
/** | ||
* The readable stream. | ||
*/ | ||
readable: ReadableStream<Omit<Entry, 'getData'> & { readable?: ReadableStream<Uint8Array>; }>; | ||
/** | ||
* The readable stream. | ||
*/ | ||
readable: ReadableStream< | ||
Omit<Entry, "getData"> & { readable?: ReadableStream<Uint8Array> } | ||
>; | ||
/** | ||
* The writable stream. | ||
*/ | ||
writable: WritableStream<T>; | ||
/** | ||
* The writable stream. | ||
*/ | ||
writable: WritableStream<T>; | ||
} | ||
@@ -751,3 +749,3 @@ | ||
*/ | ||
interface ZipReaderConstructorOptions | ||
export interface ZipReaderConstructorOptions | ||
extends ZipReaderOptions, GetEntriesOptions, WorkerConfiguration { | ||
@@ -771,3 +769,3 @@ /** | ||
*/ | ||
interface ZipReaderGetEntriesOptions | ||
export interface ZipReaderGetEntriesOptions | ||
extends GetEntriesOptions, EntryOnprogressOptions {} | ||
@@ -778,3 +776,3 @@ | ||
*/ | ||
interface GetEntriesOptions { | ||
export interface GetEntriesOptions { | ||
/** | ||
@@ -793,3 +791,3 @@ * The encoding of the filename of the entry. | ||
*/ | ||
interface ZipReaderCheckPasswordOptions { | ||
export interface ZipReaderCheckPasswordOptions { | ||
/** | ||
@@ -806,3 +804,3 @@ * `true` to check only if the password is valid. | ||
*/ | ||
interface ZipReaderOptions { | ||
export interface ZipReaderOptions { | ||
/** | ||
@@ -992,3 +990,3 @@ * `true` to check the signature of the entry. | ||
*/ | ||
interface EntryGetDataOptions | ||
export interface EntryGetDataOptions | ||
extends EntryDataOnprogressOptions, ZipReaderOptions, WorkerConfiguration {} | ||
@@ -999,3 +997,3 @@ | ||
*/ | ||
interface EntryGetDataCheckPasswordOptions | ||
export interface EntryGetDataCheckPasswordOptions | ||
extends EntryGetDataOptions, ZipReaderCheckPasswordOptions {} | ||
@@ -1040,43 +1038,48 @@ | ||
export class ZipWriterStream { | ||
/** | ||
* Creates the stream. | ||
* | ||
* @param options The options. | ||
*/ | ||
constructor (options?: ZipWriterConstructorOptions); | ||
/** | ||
* Creates the stream. | ||
* | ||
* @param options The options. | ||
*/ | ||
constructor(options?: ZipWriterConstructorOptions); | ||
/** | ||
* The readable stream. | ||
*/ | ||
readable: ReadableStream<Uint8Array>; | ||
/** | ||
* The readable stream. | ||
*/ | ||
readable: ReadableStream<Uint8Array>; | ||
/** | ||
* The ZipWriter property. | ||
*/ | ||
zipWriter: ZipWriter<unknown> | ||
/** | ||
* The ZipWriter property. | ||
*/ | ||
zipWriter: ZipWriter<unknown>; | ||
/** | ||
* Returns an object containing a readable and writable property for the .pipeThrough method | ||
* | ||
* @param path The name of the stream when unzipped. | ||
* @returns An object containing readable and writable properties | ||
*/ | ||
transform<T>(path: string): { readable: ReadableStream<T>, writable: WritableStream<T>; }; | ||
/** | ||
* Returns an object containing a readable and writable property for the .pipeThrough method | ||
* | ||
* @param path The name of the stream when unzipped. | ||
* @returns An object containing readable and writable properties | ||
*/ | ||
transform<T>( | ||
path: string, | ||
): { readable: ReadableStream<T>; writable: WritableStream<T> }; | ||
/** | ||
* Returns a WritableStream for the .pipeTo method | ||
* | ||
* @param path The directory path of where the stream should exist in the zipped stream. | ||
* @returns A WritableStream. | ||
*/ | ||
writable<T>(path: string): WritableStream<T>; | ||
/** | ||
* Returns a WritableStream for the .pipeTo method | ||
* | ||
* @param path The directory path of where the stream should exist in the zipped stream. | ||
* @returns A WritableStream. | ||
*/ | ||
writable<T>(path: string): WritableStream<T>; | ||
/** | ||
* Writes the entries directory, writes the global comment, and returns the content of the zipped file. | ||
* | ||
* @param comment The global comment of the zip file. | ||
* @param options The options. | ||
* @returns The content of the zip file. | ||
*/ | ||
close(comment?: Uint8Array, options?: ZipWriterCloseOptions): Promise<unknown>; | ||
/** | ||
* Writes the entries directory, writes the global comment, and returns the content of the zipped file. | ||
* | ||
* @param comment The global comment of the zip file. | ||
* @param options The options. | ||
* @returns The content of the zip file. | ||
*/ | ||
close( | ||
comment?: Uint8Array, | ||
options?: ZipWriterCloseOptions, | ||
): Promise<unknown>; | ||
} | ||
@@ -1158,3 +1161,3 @@ | ||
*/ | ||
interface ZipWriterAddDataOptions | ||
export interface ZipWriterAddDataOptions | ||
extends | ||
@@ -1183,3 +1186,3 @@ ZipWriterConstructorOptions, | ||
*/ | ||
interface ZipWriterCloseOptions extends EntryOnprogressOptions { | ||
export interface ZipWriterCloseOptions extends EntryOnprogressOptions { | ||
/** | ||
@@ -1202,3 +1205,3 @@ * `true` to use Zip64 to write the entries directory. | ||
*/ | ||
interface ZipWriterConstructorOptions { | ||
export interface ZipWriterConstructorOptions { | ||
/** | ||
@@ -1358,3 +1361,3 @@ * `true` to use Zip64 to store the entry. | ||
*/ | ||
interface EntryDataOnprogressOptions { | ||
export interface EntryDataOnprogressOptions { | ||
/** | ||
@@ -1387,3 +1390,3 @@ * The function called when starting compression/decompression. | ||
*/ | ||
interface EntryOnprogressOptions { | ||
export interface EntryOnprogressOptions { | ||
/** | ||
@@ -1846,3 +1849,3 @@ * The function called each time an entry is read/written. | ||
*/ | ||
interface ZipDirectoryEntryImportHttpOptions | ||
export interface ZipDirectoryEntryImportHttpOptions | ||
extends ZipReaderConstructorOptions, HttpOptions {} | ||
@@ -1853,3 +1856,3 @@ | ||
*/ | ||
interface ZipDirectoryEntryExportOptions | ||
export interface ZipDirectoryEntryExportOptions | ||
extends ZipWriterConstructorOptions, EntryDataOnprogressOptions { | ||
@@ -1856,0 +1859,0 @@ /** |
@@ -6,3 +6,3 @@ { | ||
"license": "BSD-3-Clause", | ||
"version": "2.7.35", | ||
"version": "2.7.36", | ||
"type": "module", | ||
@@ -9,0 +9,0 @@ "keywords": [ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
3077243
68
58565