Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix documentation for async(type[, onUpdate]) #456

Closed
dsego opened this issue Sep 5, 2017 · 1 comment
Closed

Fix documentation for async(type[, onUpdate]) #456

dsego opened this issue Sep 5, 2017 · 1 comment

Comments

@dsego
Copy link

dsego commented Sep 5, 2017 •
edited
Loading

On doc page for the async method (http://stuk.github.io/jszip/documentation/api_zipobject/async.html)
the example given uses a configuration object:

.async({type: "uint8array"})

This doesn't work when I try it in my code (JSZip v3.1.3)

But if I change it to .async("uint8array"), it works just fine.
@dsego dsego changed the title Fix documentation Fix documentation for async(type[, onUpdate]) Sep 5, 2017
@dduponchel
Copy link
Collaborator

Good catch ! It seems like a confusion between async() and generateAsync().

dduponchel added a commit to dduponchel/jszip that referenced this issue Sep 5, 2017
@dduponchel
Fix async() examples
e010365 
The example incorrectly used `.async({type: "uint8array"})` instead of
`.async("uint8array")`.

Fixes Stuk#456.
@dduponchel dduponchel mentioned this issue Sep 5, 2017
Merged
jmerdich pushed a commit to jmerdich/jszip that referenced this issue Jan 6, 2019
@dduponchel @jmerdich
Fix async() examples
d4defd5 
The example incorrectly used `.async({type: "uint8array"})` instead of
`.async("uint8array")`.

Fixes Stuk#456.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dduponchel @dsego