Refactor and docs #23
Open
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
vladimyr
force-pushed
the
refactor-and-docs
branch
from
7d2bea0 to
1b0c642
Compare
vladimyr
commented
Feb 15, 2020
|
Ok I'll bring them back and mark as deprecated with warning saying they'll
be removed in upcoming v5 major version.
…On Sun, Feb 16, 2020, 01:44 William Casarin ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In index.js
<#23 (comment)>:
> -S3BlobStore.prototype.uploadParams = function (opts) {
- opts = Object.assign({}, opts, {
- params: Object.assign({}, opts.params)
- });
-
- var filename = opts.name || opts.filename;
- var key = opts.key || filename;
- var contentType = opts.contentType;
-
- var params = opts.params;
- params.Bucket = params.Bucket || this.bucket;
- params.Key = params.Key || key;
-
- if (!contentType) {
- contentType = filename ? mime.lookup(filename) : mime.lookup(opts.key);
- }
- if (contentType) params.ContentType = contentType;
-
- return params;
-};
-
-S3BlobStore.prototype.downloadParams = function (opts) {
- var params = this.uploadParams(opts);
- delete params.ContentType;
- return params;
-};
unless the behavior is exactly the same I would consider it a breaking
change, so we can push this as v5 if so
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#23?email_source=notifications&email_token=AAI5YCAWX3BNVNDNS4FJYFLRDCD7HA5CNFSM4KV3TKZKYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCVVZXLQ#discussion_r379866278>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAI5YCBDBQT2HYOOALC6N53RDCD7HANCNFSM4KV3TKZA>
.
|
|
can we have the docs separate from the refactor? I would like to pull the docs for now and perhaps the refactor later after I have more time to review. Commit wise I'm thinking doc commits first and then refactor commits after (with doc adjustments if needed) |
|
needs rebase |
- extending all public API methods to support passing additional s3 parameters either through `opts` argument or dedicated `s3opts` argument - introducing `store#_s3paramsi(opts, s3opts)` helper used for extracting additional s3 parameters - deprecating undocumented `uploadParams` and `downloadParams` methods to prepare for new major release - updating API documentation
vladimyr
force-pushed
the
refactor-and-docs
branch
from
04d0fd3 to
08c3d28
Compare
✅ Done |
|
> needs rebase
✅ Done
awesome, much easier to see the changes now. thanks! will take a look at
it soon
|
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.
This PR brings in backward compatible public API changes to support passing optional
s3optsparam. JSDoc annotations are being added to support documentation generation. 🎉