docs: document destination option #633
Merged
Conversation
This file contains 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
| @@ -116,6 +116,8 @@ async function uploadFile(bucketName, filename) { | |||
| await storage.bucket(bucketName).upload(filename, { | |||
| // Support for HTTP requests made with `Accept-Encoding: gzip` | |||
| gzip: true, | |||
| // By setting the option `destination`, you can change the name of the | |||
There was a problem hiding this comment.
It's a little weird for me to read the comment in this context. I'd expect to see something like this above a destination property in the obj, which could be commented out, but there for illustration.
There was a problem hiding this comment.
so perhaps:
// destination: destinationFilename (defaults to filename)
Codecov Report
@@ Coverage Diff @@
## master #633 +/- ##
=======================================
Coverage 97.94% 97.94%
=======================================
Files 9 9
Lines 874 874
Branches 99 99
=======================================
Hits 856 856
Misses 9 9
Partials 9 9Continue to review full report at Codecov.
|
JustinBeckwith
approved these changes
Mar 26, 2019
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.
It's often the case that a user wants to change the destination name of an object they're uploading, but it's pretty buried in the docs.