uppy/docs
Mikael Finstad 151da8bdfe
coalesce options bucket and getKey (#5169)
* coalesce options `bucket` and `getKey`

this is a breaking change!
also:
- remove `req` because it's an internal, unstable api that might change any time and should not be used directly
- use an params object for getKey/bucket functions instead of positional arguments, to make it more clean, and easier to add more data in the future
- add metadata to `bucket` whenever we are aware of it

* fix lint

* Apply suggestions from code review

Co-authored-by: Antoine du Hamel <antoine@transloadit.com>

* add back `Request` object

also add filename to `bucket` for consistency

* add migration steps

* fix lint

* Update docs/guides/migration-guides.md

Co-authored-by: Antoine du Hamel <antoine@transloadit.com>

---------

Co-authored-by: Antoine du Hamel <antoine@transloadit.com>
2024-06-13 23:32:38 +02:00
..
framework-integrations Release: uppy@4.0.0-beta.7 (#5162) 2024-05-14 15:14:15 +00:00
guides coalesce options bucket and getKey (#5169) 2024-06-13 23:32:38 +02:00
presets Release: uppy@4.0.0-beta.7 (#5162) 2024-05-14 15:14:15 +00:00
sources Merge stable branch 2024-06-04 17:17:01 +02:00
uploader @uppy/aws-s3: add endpoint option (#5173) 2024-06-13 14:55:12 +02:00
user-interfaces Release: uppy@4.0.0-beta.7 (#5162) 2024-05-14 15:14:15 +00:00
companion.md coalesce options bucket and getKey (#5169) 2024-06-13 23:32:38 +02:00
compressor.mdx docs: add back markdown files (#5064) 2024-04-16 15:24:58 +02:00
form.mdx docs: add back markdown files (#5064) 2024-04-16 15:24:58 +02:00
golden-retriever.mdx docs: add back markdown files (#5064) 2024-04-16 15:24:58 +02:00
locales.mdx docs: add back markdown files (#5064) 2024-04-16 15:24:58 +02:00
quick-start.mdx docs: use StackBlitz for all examples/issue template (#5125) 2024-04-29 15:24:58 +02:00
README.md Improve provider docs: Box & Zoom (#5166) 2024-05-16 11:06:53 +02:00
uppy-core.mdx Merge stable branch 2024-06-04 17:17:01 +02:00

Uppy documentation

See instructions for linting this documentation and seeing this documentation in the browser in https://github.com/transloadit/uppy.io.