Type definitions for JSZip #601
Conversation
|
Sorry to ping @Stuk could this PR be reviewed? |
| compressedContent: string|ArrayBuffer|Uint8Array|Buffer; | ||
| } | ||
|
|
||
| type InputFileFormat = InputByType[keyof InputByType]; |
There was a problem hiding this comment.
InputFileFormat's type is the element of interface InputByType, like string, an array of number, Unit8Array, ArrayBuffer or Blob.
| dosPermissions: number | null; | ||
| options: JSZipObjectOptions; | ||
|
|
||
| _data: CompressedObject; |
There was a problem hiding this comment.
This is private, so I don't think it should be part of the TS interface.
There was a problem hiding this comment.
Yes, but sometimes we need to get the compression size and origin file's size.
There was a problem hiding this comment.
Hmm. I'm not comfortable explicitly exposing deliberately private properties.
Could you remove this property from this PR, and open another PR that exposes this property explicitly?
| * @param options Optional information about the file | ||
| * @return JSZip object | ||
| */ | ||
| file<T extends JSZip.InputType>(path: string, data: InputByType[T] | Promise<InputByType[T]>, options?: JSZip.JSZipFileOptions): this; |
There was a problem hiding this comment.
On use does one need to write file<Blob>(...), or will it be inferred from the data argument?
There was a problem hiding this comment.
It'll be inferred from the data argument.
| * @param onUpdate The optional function called on each internal update with the metadata. | ||
| * @return A Node.js `ReadableStream` | ||
| */ | ||
| generateNodeStream(options?: JSZip.JSZipGeneratorOptions<'nodebuffer'>, onUpdate?: OnUpdateCallback): NodeJS.ReadableStream; |
There was a problem hiding this comment.
Interesting, so the type is a string (nodebuffer) instead of the type itself?
There was a problem hiding this comment.
Why is this a string and not the type?
|
Any updates on this? |
|
Hi guys, thanks for the awesome JSZip. I'm using TS and wonder if you guys have intention to merge this PR ? Thanks |
|
We're using TypeScript and JSZip 3.4.0 failed our CI build. Needed just a little configuration change, but still a breaking change. before (breaking with 3.4.0): import JSZip = require("jszip");
// starting with jszip 3.4.0, JSZip.JSZip is not found,
// probably because of new possibly conflicting TypeScript definitions
const zip: JSZip.JSZip = new JSZip();
// (zip.load...)
return zip.file("test.xml").async("string");now working: import JSZip from "jszip";
const zip: JSZip = new JSZip();
// (zip.load...)
return zip.file("test.xml").async("text");This may also have to do with us using I also was a bit surprised that "string" was suddenly not valid anymore, the typescript definition allows various strings now, "text" one of them. also, using the package es6-promise caused a conflict with Promise, but it was apparently unnecessary anyways, so i simply removed it. Our greenkeeper CI issue, for reference (references our fixing commit): |
Suport typescript Type definitions