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

docs: fix allowedMetaFields documentation #4216

Merged
merged 1 commit into from
Nov 15, 2022
Merged

docs: fix allowedMetaFields documentation #4216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions website/src/docs/aws-s3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ uppy.use(AwsS3, {

Custom headers that should be sent along to [Companion][companion docs] on every request.

### `allowedMetaFields: null`
### `allowedMetaFields: []`

Pass an array of field names to limit the metadata fields that will be added to upload as query parameters.

* Set this to an empty array `[]` to not send any fields (this is the default).
* Set this to `['name']` to only send the `name` field.
* Set this to `null` (the default) to send _all_ metadata fields.
* Set this to an empty array `[]` to not send any fields.
* Set this to `null` to send _all_ metadata fields.

### `getUploadParameters(file)`

Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/tus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ new Uppy().use(Tus, {

Pass an array of field names to limit the metadata fields that will be added to uploads as [Tus Metadata](https://tus.io/protocols/resumable-upload.html#upload-metadata).

* Set this to an empty array `[]` to not send any fields.
* Set this to `['name']` to only send the `name` field.
* Set this to `null` (the default) to send _all_ metadata fields.
* Set this to an empty array `[]` to not send any fields.

### `limit: 5`

Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/xhr-upload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ is set to `true`, otherwise it defaults to `'file'`.

Pass an array of field names to limit the metadata fields that will be added to upload.

* Set this to an empty array `[]` to not send any fields.
* Set this to `['name']` to only send the `name` field.
* Set this to `null` (the default) to send _all_ metadata fields.
* Set this to an empty array `[]` to not send any fields.

If the [`formData`](#formData-true) option is set to false, `metaFields` is ignored.

Expand Down