Repository navigation
Document that create does not strip the path from filename - #147
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Since 2.0.0,
createno longer runs the filename throughbasename(the v2.0.0 release notes call this out), but the README doesn't mention it, and its "Send a file for download" example still passes the full path:Copying that example sends the server's directory layout to the client. Under 1.x the same code produced
filename="plans.pdf", so anyone who upgraded without reading the release notes gets a leak and nothing tells them.Changes (README only):
create(filename, options)that the filename is used as given and should be a bare file name (e.g.path.basename), not a full path.create(path.basename(filePath)), which producesattachment; filename=plans.pdf.contentDisposition accepts these propertiesline to saycreate, since the default export was removed in 2.0.0.I checked both outputs above against the built
dist/.npm testpasses and Prettier is clean.