Skip to content

Commit

Permalink
docs: correct allowedMetaFields (#5227)
Browse files Browse the repository at this point in the history
  • Loading branch information
Murderlon committed Jun 10, 2024
1 parent d1094e1 commit 1f44dc7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/uploader/aws-s3-multipart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -386,9 +386,9 @@ The default implementation calls out to Companion’s S3 signing endpoints.
Pass an array of field names to limit the metadata fields that will be added to
upload as query parameters.

- 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 it to `false` to not send any fields (or an empty array).
- Set it to `['name']` to only send the `name` field.
- Set it to `true` (the default) to send _all_ metadata fields.

<details>
<summary>Deprecated options</summary>
Expand Down
6 changes: 3 additions & 3 deletions docs/uploader/tus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -215,9 +215,9 @@ uploads as
[Tus Metadata](https://tus.io/protocols/resumable-upload.html#upload-metadata)
(`Array`, default: `null`).
- 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 it to `false` to not send any fields (or an empty array).
- Set it to `['name']` to only send the `name` field.
- Set it to `true` (the default) to send _all_ metadata fields.
#### `limit`
Expand Down
6 changes: 3 additions & 3 deletions docs/uploader/xhr.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ 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 it to `false` to not send any fields (or an empty array).
- Set it to `['name']` to only send the `name` field.
- Set it to `true` (the default) to send _all_ metadata fields.

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

0 comments on commit 1f44dc7

Please sign in to comment.